logux_rails 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2ddee267525e7f6503a6a64b42b4b18322dd7a597c1f535f5c3341921bad354
-  data.tar.gz: b7f32ba3524a11d9a81872064231cc939773cc68a22029a3cf52e48253fafeb6
+  metadata.gz: 97f35ecf2895e15f1ca45d1ec4d4aec86108d8ffdb48e7ff112d06b5593a4477
+  data.tar.gz: '0568b3e3bad4592b33b0f5ecfd24ccbe4fb980ff8e037b30cc4bf0e2f12d9549'
 SHA512:
-  metadata.gz: 5a82d8cf1df3c2c228b4e6a371cf027d146cb59bc67f338cbef4103745132047f56224024fa9b24347d5b3734ead07afe4d0ca744b0b7d8eef07fe3a246d8e38
-  data.tar.gz: 7d9efeb074215bb2ac5c3d601ded5425f2c927efe5f6ed7c4f749c6f49b9f1fb33b4b40abdd0b9145912f1ecc17c08b3bca99580cd9f8a49fecbe2997a1869c3
+  metadata.gz: cf3aa01217dbf9d6175b7ad846d0c4da52df51b9a63f555ec0655c05e5016a5dea5a1c8126625533fce36a8eb45f4df4690f69fe3e2cf4928df6ac91fde2a52f
+  data.tar.gz: b105c769a9c97b363da83f6deba35ba7cd026a5b0eb70a780e1936c9c51d6c64465de295c9d32aab977e80d0373b7755e2eece5503610c4d579c92a3f7459b5d

data/.travis.yml

@@ -1,3 +1,4 @@
+language: minimal
 sudo: require
 services:
   - docker

data/Appraisals

@@ -11,3 +11,7 @@ end
 appraise '5.2' do
   gem 'activerecord', '~> 5.2'
 end
+
+appraise '6.0' do
+  gem 'activerecord', '~> 6.0'
+end

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+## 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.

data/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'

data/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
 

data/app/helpers/logux_helper.rb

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

data/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

data/lib/logux/{actions.rb → 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

data/lib/logux/model/proxy.rb

@@ -13,7 +13,7 @@ module Logux
           logux_order: meta.logux_order,
           attributes: attributes
         )
-        @model.update_attributes(updater.updated_attributes)
+        @model.update(updater.updated_attributes)
       end
 
       def updated_at(field)

data/lib/logux/model/updates_deprecator.rb

@@ -5,17 +5,15 @@ module Logux
     class UpdatesDeprecator
       EVENT = 'logux.insecure_update'
 
-      class << self
-        def watch(args = {}, &block)
-          new(args).watch(&block)
-        end
+      def self.call(options = {}, &block)
+        new(options).call(&block)
       end
 
-      def initialize(level: :warn)
-        @level = level
+      def initialize(options)
+        @options = options
       end
 
-      def watch(&block)
+      def call(&block)
         callback = lambda(&method(:handle_insecure_update))
         ActiveSupport::Notifications.subscribed(callback, EVENT, &block)
       end
@@ -42,13 +40,19 @@ module Logux
           Logux tracked #{pluralized_attributes} (#{insecure_attributes.join(', ')}) should be updated using model.logux.update(...)
         TEXT
 
-        case @level
+        case level
         when :warn
           ActiveSupport::Deprecation.warn(message)
         when :error
           raise InsecureUpdateError, message
         end
       end
+
+      DEFAULT_LEVEL = :warn
+
+      def level
+        @options[:level] || DEFAULT_LEVEL
+      end
     end
   end
 end

data/lib/logux/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Logux
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/logux_rails.rb

@@ -1,3 +1,24 @@
 # frozen_string_literal: true
 
-require 'logux'
+require 'action_controller'
+require 'active_support'
+require 'logux/rack'
+require 'rails/engine'
+require 'logux/engine'
+
+module Logux
+  autoload :Model, 'logux/model'
+
+  configurable %i[
+    action_watcher
+    action_watcher_options
+  ]
+
+  configuration_defaults do |config|
+    config.action_watcher = Logux::Model::UpdatesDeprecator
+    config.action_watcher_options = { level: :error }
+    config.logger = Rails.logger if defined?(Rails.logger)
+    config.logger ||= ActiveSupport::Logger.new(STDOUT)
+    config.on_error = proc {}
+  end
+end

data/lib/tasks/logux_tasks.rake

@@ -1,46 +1,19 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/BlockLength
-namespace :logux do
-  desc 'Lists all Logux action types'
-  task actions: :environment do
-    Dir[Rails.root.join('app', 'logux', 'actions', '**', '*.rb')].each do |file|
-      require file
-    end
+require 'logux/rake_tasks'
 
-    output = [%w[action.type Class#method]]
-    Logux::ActionController.descendants.sort_by(&:name).each do |klass|
-      klass.instance_methods(false).sort.each do |action|
-        output << [
-          "#{klass.name.gsub(/^Actions::/, '').underscore}/#{action}",
-          "#{klass.name}##{action}"
-        ]
-      end
-    end
+module Logux
+  class RakeTasks
+    protected
 
-    first_column_length = output.map(&:first).max_by(&:length).length
-    output.each do |action, klass_name|
-      puts "#{action.rjust(first_column_length, ' ')} #{klass_name}"
+    def default_actions_path
+      ::Rails.root.join('app', 'logux', 'actions')
     end
-  end
-
-  desc 'Lists all Logux channels'
-  task channels: :environment do
-    path = Rails.root.join('app', 'logux', 'channels', '**', '*.rb')
-    Dir[path].each { |file| require file }
 
-    output = [%w[channel Class]]
-    Logux::ChannelController.descendants.map(&:name).sort.each do |klass_name|
-      output << [
-        klass_name.gsub(/^Channels::/, '').underscore,
-        klass_name
-      ]
-    end
-
-    first_column_length = output.map(&:first).max_by(&:length).length
-    output.each do |channel, klass_name|
-      puts "#{channel.rjust(first_column_length, ' ')} #{klass_name}"
+    def default_channels_path
+      ::Rails.root.join('app', 'logux', 'channels')
     end
   end
 end
-# rubocop:enable Metrics/BlockLength
+
+Logux::RakeTasks.new

data/logux_rails.gemspec

@@ -22,14 +22,11 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'colorize'
-  spec.add_dependency 'configurations'
-  spec.add_dependency 'nanoid'
-  spec.add_dependency 'rails', '>= 5.0'
-  spec.add_dependency 'rest-client'
+  spec.add_dependency 'logux-rack', '>= 0.1.0'
+  spec.add_dependency 'rails', '>= 5.0', '< 6.1'
   spec.add_development_dependency 'appraisal', '~> 2.2'
   spec.add_development_dependency 'bundler', '~> 1.16'
-  spec.add_development_dependency 'combustion', '~> 1.0.0'
+  spec.add_development_dependency 'combustion', '~> 1.1.0'
   spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'pg'

metadata

@@ -1,57 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: logux_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - WildDima
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-07-09 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: colorize
+  name: logux-rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: configurations
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: nanoid
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -66,20 +41,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -318,11 +282,11 @@ files:
 - ".rubocop_todo.yml"
 - ".travis.yml"
 - Appraisals
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/logux_controller.rb
 - app/helpers/logux_helper.rb
 - app/logux/actions.rb
 - app/logux/policies.rb
@@ -333,40 +297,13 @@ files:
 - lib/generators/logux/model/USAGE
 - lib/generators/logux/model/model_generator.rb
 - lib/generators/logux/model/templates/migration.rb.erb
-- lib/logux.rb
-- lib/logux/action_caller.rb
-- lib/logux/action_controller.rb
-- lib/logux/actions.rb
-- lib/logux/add.rb
-- lib/logux/auth.rb
-- lib/logux/base_controller.rb
-- lib/logux/channel_controller.rb
-- lib/logux/class_finder.rb
-- lib/logux/client.rb
+- lib/logux/action.rb
 - lib/logux/engine.rb
-- lib/logux/error_renderer.rb
-- lib/logux/meta.rb
 - lib/logux/model.rb
 - lib/logux/model/dsl.rb
 - lib/logux/model/proxy.rb
 - lib/logux/model/updater.rb
 - lib/logux/model/updates_deprecator.rb
-- lib/logux/node.rb
-- lib/logux/policy.rb
-- lib/logux/policy_caller.rb
-- lib/logux/process.rb
-- lib/logux/process/action.rb
-- lib/logux/process/auth.rb
-- lib/logux/process/batch.rb
-- lib/logux/response.rb
-- lib/logux/stream.rb
-- lib/logux/test.rb
-- lib/logux/test/helpers.rb
-- lib/logux/test/matchers.rb
-- lib/logux/test/matchers/base.rb
-- lib/logux/test/matchers/response_chunks.rb
-- lib/logux/test/matchers/send_to_logux.rb
-- lib/logux/test/store.rb
 - lib/logux/version.rb
 - lib/logux_rails.rb
 - lib/tasks/logux_tasks.rake

data/app/controllers/logux_controller.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-class LoguxController < ActionController::Base
-  include ActionController::Live
-
-  def create
-    logux_stream.write('[')
-    Logux.verify_request_meta_data(meta_params)
-    Logux.process_batch(stream: logux_stream, batch: command_params)
-  rescue => ex
-    handle_processing_errors(ex)
-  ensure
-    logux_stream.write(']')
-    logux_stream.close
-  end
-
-  private
-
-  def unsafe_params
-    params.to_unsafe_h
-  end
-
-  def command_params
-    unsafe_params.dig('commands')
-  end
-
-  def meta_params
-    unsafe_params&.slice(:version, :password)
-  end
-
-  def logux_stream
-    @logux_stream ||= Logux::Stream.new(response.stream)
-  end
-
-  def handle_processing_errors(exception)
-    Logux.configuration.on_error.call(exception)
-    Logux.logger.error("#{exception}\n#{exception.backtrace.join("\n")}")
-  ensure
-    logux_stream.write(Logux::ErrorRenderer.new(exception).message)
-  end
-end