Merge pull request #81 from logux/logux-rack

Extract logux-rack gem

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-# 0.1
+## 0.2
+* Core Logux facilities are moved to `logux-rack` gem.
+* `Logux::Actions` is soft-deprecated. Please use `Logux::Action` from now on.
+* `Logux::Model::UpdatesDeprecator` is now coupled with `Logux::ActionCaller` via Logux configuration.
+
+## 0.1.1
+* Rails 6.0 support.
+
+## 0.1
 * Initial release.

Gemfile

@@ -6,3 +6,6 @@ git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in logux_rails.gemspec
 gemspec
+
+# NOTE: Remove this line after logux-rack is released on rubygems
+gem 'logux-rack', github: 'logux/logux-rack'

README.md

@@ -30,17 +30,22 @@ Logux.configuration do |config|
 end
 ```
 
-Mount logux in routes:
+Mount `Logux::Rack` in your application routing configuration:
 
 ```ruby
+# config/routes.rb
+Rails.application.routes.draw do
   mount Logux::Engine => '/'
+end
 ```
 
 After this, POST requests to `/logux` will be processed by `LoguxController`. You can redefine it or inherit from, if it necessary, for example, for implementing custom authorization flow.
 
 Logux Rails will try to find Action for the specific message from Logux Server. For example, for `project/rename` action, you should define `Action::Project` class, inherited from `Logux::Action` base class, and implement `rename` method.
 
-You can execute `rake logux:actions` to get the list of available action types, or `rake logux:channels` to get the list of available channels.
+### Rake commands
+
+Use `rails logux:actions` command to get the list of available action types, or `rails logux:channels` for channels. The default search path is set to `app/logux/actions` and `app/logux/channels` for actions and channels correspondingly, assuming `app` directory is the root of your Rails application. Both command support custom search paths: `rails logux:actions[lib/logux/actions]`.
 
 ## Development with Docker
 

app/helpers/logux_helper.rb

@@ -1,4 +1,3 @@
 # frozen_string_literal: true
 
-module LoguxHelper
-end
+module LoguxHelper; end

config/routes.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 Logux::Engine.routes.draw do
-  resource :logux, only: %i[create], controller: :logux
+  mount Logux::Rack::App => '/'
 end

lib/logux/actions.rb → lib/logux/action.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Logux
-  class Actions < ::ActionController::Parameters
+  class Action < ::ActionController::Parameters
     def action_name
       type&.split('/')&.dig(0)
     end