light_operations 0.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22e10ab9bc6fe6041bb01667f862f63f50077231
-  data.tar.gz: 2f04f75361aced6d9c1f8dffaf2f43bd1cef1578
+  metadata.gz: 68f26aea2a62fc1c53c4e05094c20c3f36bab95f
+  data.tar.gz: cc579e8a2d4b64700339f275abccf89e129661fa
 SHA512:
-  metadata.gz: e00cdb8eb532f6b600803134315b47e0be787b897c630b24dff00dbe022e7141099413adb3f41b40979388ab2fe0ee8071a813f591fb5a1be91e9b20f39001da
-  data.tar.gz: 5a2e2e59c4623d73614d6196960b8e1dfe723201750e84b2f4c4d3b7b1e26eb12ea6abea29b7e902323a3b36fef1ecea1b57b0afa65c972699178582456cfcda
+  metadata.gz: 097e63174c71d528b9d00a24e70dd67d115b1baaedd039a225d30c5c5df9aea21270765ea992a6f16d79e955e091414543e8de3c7d27af0c255fdb3f1591701f
+  data.tar.gz: 1c3a955b4f7e2f3d1505a7038e41c4619b5cd332ffe52d06f677c4dd7baf36a0b6e93b268a35cf48c54873ccc8421a54465206163e239c37466fb9fc8a03357b

data/README.md

@@ -24,6 +24,8 @@ Or install it yourself as:
 
     $ gem install light_operations
 
+ **Important latest version of gem > 1.2.x works only with ruby 2.x**
+
 ## How it works
 
 Basicly this is a Container for buissnes logic.
@@ -502,6 +504,110 @@ When operation status is most importent we can simply use `#success?` or `#fail?
 
 Errors are available by `#errors` after operation is executed
 
+### Whats new in 1.2.x
+New module LightOperations::Flow which gives very simple and easy way to create operation per action in controller (tested on rails).
+
+#### How it works:
+
+include module in controller like this
+```ruby
+class AccountsController < VersionController
+  include LightOperations::Flow
+  operation :accounts, namespace: Operations, actions: [:create, :show]
+  def render_create(op)
+    render text: op.subject
+  end
+
+  def render_fail_create(op)
+    render text: op.errors # or if you want to show form use 'op.subject'
+  end
+end
+```
+
+Now create operation class for account creation (components/operations/accounts/create.rb):
+
+```ruby
+module Operations
+  module Accounts
+    class Create < LightOperations::Core
+      rescue_from ActiveRecord::RecordInvalid, with: :invalid_record_handler
+
+      def execute(params:)
+        Account.create!(params.require(:account))
+      end
+
+      private
+
+      def invalid_record_handler(ex)
+        fail!(ex.record.errors)
+      end
+    end
+  end
+end
+```
+
+add into `application.rb`
+
+```ruby
+config.autoload_paths += %W(
+  #{config.root}/app/components
+)
+```
+
+But it is not all :D (operation params gives you a lot more)
+
+```ruby
+class AccountsController < VersionController
+  include LightOperations::Flow
+  operation(
+    :accounts, # top level namespace
+    namespace: Operations, # Base namespace by default is Kernel
+    actions: [:create, :show], # those are operations executed by router
+    default_view: nil, # By changing this option you can have one method for render all successful operations for all actions.
+    view_prefix: 'render_', # By changing this you can have #view_create instead of #render_create
+    default_fail_view: nil, # By changing this option you can have one method for render all failed operations for all actions.
+    fail_view_prefix: 'render_fail_' # By changing this you can have #view_fail_create instead of #render_fail_create
+end
+```
+
+This simple module should give you power to create something like this:
+
+```ruby
+module Api
+  module V1
+    class AccountsController < VersionController
+      include LightOperations::Flow
+      skip_before_action :authorize, only: [:create, :password_reset]
+      operation :accounts,
+                namespace: Operations,
+                actions: [:create, :update, :show, :destroy, :password_reset],
+                default_fail_view: :render_error
+
+      private
+
+      def render_operation_error(op)
+        render json: op.errors, status: 422 # you can have status in operation if you want
+      end
+
+      def render_account(op)
+        render json: AccountOwnerSerializer.new(op.account), status: op.status
+      end
+
+      def render_no_content(_op)
+        render nothing: true, status: :no_content
+      end
+
+      alias_method :render_update, :render_account
+      alias_method :render_create, :render_account
+      alias_method :render_password_reset, :render_no_content
+      alias_method :render_destroy, :render_no_content
+    end
+  end
+end
+
+
+```
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/light_operations/fork )

data/lib/light_operations/flow.rb

@@ -0,0 +1,33 @@
+module LightOperations
+  module Flow
+    def self.included(base)
+      base.send(:extend, ClassMethods)
+    end
+
+    attr_reader :operation_opts, :operation_dependencies
+
+    module ClassMethods
+      def operation(operation_name, namespace: Kernel, actions: [], default_view: nil, view_prefix: 'render_', default_fail_view: nil, fail_view_prefix: 'render_fail_')
+        actions.each do |action_name|
+          operation_method = "#{action_name}_op"
+
+          define_method(action_name.to_s) do
+            send(operation_method).run((operation_opts || {}).merge(params: params))
+          end
+
+          define_method(operation_method) do
+            success_view = default_view || "#{view_prefix}#{action_name}".to_sym
+            fail_view    = default_fail_view || "#{fail_view_prefix}#{action_name}".to_sym
+            const        = operation_name.to_s.titleize.delete(' ')
+            action       = action_name.to_s.titleize.delete(' ')
+            namespace.const_get(const).const_get(action)
+              .new(operation_dependencies)
+              .bind_with(self)
+              .on_success(success_view)
+              .on_fail(fail_view)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/light_operations/version.rb

@@ -1,3 +1,3 @@
 module LightOperations
-  VERSION = '0.1.1'
+  VERSION = '1.2.0'
 end

data/lib/light_operations.rb

@@ -1,5 +1,6 @@
 require 'light_operations/version'
 require 'light_operations/core'
+require 'light_operations/flow'
 
 module LightOperations
 end

data/light_operations.gemspec

@@ -18,11 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'activesupport', '>= 3.0.2'
-  spec.add_development_dependency 'bundler', '>= 1.6'
+  spec.add_runtime_dependency 'activesupport', '~> 3.0'
+  spec.add_development_dependency 'rails', '~> 3.2'
+  spec.add_development_dependency 'test-unit', '~> 3.0'
+  spec.add_development_dependency 'bundler', '~> 1.6'
   spec.add_development_dependency 'rake', '~> 10.4'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'guard', '~> 2.12'
+  spec.add_development_dependency 'rspec-rails', '~> 3.0'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'guard-rubocop', '~> 1.2'
   spec.add_development_dependency 'coveralls', '~> 0.7'

data/spec/lib/flow_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+require 'action_controller/railtie'
+require 'action_view/railtie'
+require 'rspec/rails'
+require 'rspec/autorun'
+
+
+describe 'LightOperations::Flow', type: :controller do
+  RailsApp = Class.new(Rails::Application)
+  RailsApp.config.secret_key_base = '5308dcbbb7dea1b44e3d1d55ea7656f9'
+  RailsApp.config.eager_load = false
+  RailsApp.config.root = File.dirname(__FILE__)
+  RailsApp.config.generators { |g| g.test_framework :rspec }
+  RailsApp.routes.draw do
+    resources :accounts, only: [:create, :show, :update]
+  end
+
+  module TestOperations
+    module Accounts
+      class Create < LightOperations::Core
+        def execute(params:)
+          params[:correct] ? 'Create OK' : fail!('Create Fail')
+        end
+      end
+
+      class Show < LightOperations::Core
+        def execute(params:)
+          params[:correct] ? 'Show OK' : fail!('Show Fail')
+        end
+      end
+
+      class Update < LightOperations::Core
+        attr_reader :status
+        AccessDeny = Class.new(StandardError)
+        rescue_from AccessDeny, with: :access_deny_handler
+
+        def execute(params:, current_user: {})
+          @status = 200
+          fail AccessDeny unless current_user[:id].to_i == 1
+          params[:correct] ? 'Update OK' : fail_with_status!(text: 'Update Fail')
+        end
+
+        def fail_with_status!(text:, code: 422)
+          @status = code
+          fail!(text)
+        end
+
+        def access_deny_handler
+          fail_with_status!(text: 'Update access deny', code: 401)
+        end
+      end
+    end
+  end
+  context 'default use of flow' do
+    controller(RailsApp::ActionController::Base) do
+      include Rails.application.routes.url_helpers
+      include LightOperations::Flow
+      operation :accounts, namespace: TestOperations, actions: [:create]
+
+      def render_create(op)
+        render text: op.subject
+      end
+
+      def render_fail_create(op)
+        render text: op.subject
+      end
+    end
+
+
+    it '#render_create as success' do
+      post :create, correct: true
+      expect(response.body).to eq('Create OK')
+    end
+
+    it '#render_fail_create as fail' do
+      post :create, {}
+      expect(response.body).to eq('Create Fail')
+    end
+  end
+
+  context 'flow with #view_prefix and #fail_view_prefix' do
+    controller(RailsApp::ActionController::Base) do
+      include Rails.application.routes.url_helpers
+      include LightOperations::Flow
+      operation :accounts, namespace: TestOperations, actions: [:create], view_prefix: 'view_', fail_view_prefix: 'fail_view_'
+
+      def view_create(op)
+        render text: op.subject
+      end
+
+      def fail_view_create(op)
+        render text: op.subject
+      end
+    end
+
+
+    it '#view_create as success' do
+      post :create, correct: true
+      expect(response.body).to eq('Create OK')
+    end
+
+    it '#fail_view_create as fail' do
+      post :create, {}
+      expect(response.body).to eq('Create Fail')
+    end
+  end
+
+  context 'flow with #view_prefix and #fail_view_prefix as one' do
+    controller(RailsApp::ActionController::Base) do
+      include Rails.application.routes.url_helpers
+      include LightOperations::Flow
+      operation :accounts, namespace: TestOperations, actions: [:create], view_prefix: 'render_', fail_view_prefix: 'render_'
+
+      def render_create(op)
+        status = op.success? ? 200 : 404
+        render text: op.subject, status: status
+      end
+    end
+
+
+    it '#render_create as success' do
+      post :create, correct: true
+      expect(response.body).to eq('Create OK')
+      expect(response.code).to eq('200')
+    end
+
+    it '#render_create as fail' do
+      post :create, {}
+      expect(response.body).to eq('Create Fail')
+      expect(response.code).to eq('404')
+    end
+  end
+
+  context 'flow with #default_view and #default_fail_view' do
+    controller(RailsApp::ActionController::Base) do
+      include Rails.application.routes.url_helpers
+      include LightOperations::Flow
+      operation :accounts, namespace: TestOperations, actions: [:create, :show], default_view: :render_view, default_fail_view: :render_fail_view
+
+      def render_view(op)
+        render text: op.subject
+      end
+
+      def render_fail_view(op)
+        render text: op.subject, status: 422
+      end
+    end
+
+
+    it '#render_view as success' do
+      post :create, correct: true
+      expect(response.body).to eq('Create OK')
+      expect(response.code).to eq('200')
+      get :show, id: 1, correct: true
+      expect(response.body).to eq('Show OK')
+      expect(response.code).to eq('200')
+    end
+
+    it '#render_fail_view as fail' do
+      post :create, {}
+      expect(response.body).to eq('Create Fail')
+      expect(response.code).to eq('422')
+      get :show, id: 1
+      expect(response.body).to eq('Show Fail')
+      expect(response.code).to eq('422')
+    end
+  end
+
+  context 'flow with advance customization' do
+    controller(RailsApp::ActionController::Base) do
+      include Rails.application.routes.url_helpers
+      include LightOperations::Flow
+      operation :accounts, namespace: TestOperations, actions: [:update], default_view: :render_view, default_fail_view: :render_error
+
+      def render_view(op)
+        render text: op.subject, status: op.status
+      end
+
+      def render_error(op)
+        render text: op.errors, status: op.status
+      end
+
+      def operation_opts
+        { current_user: { id: params[:id] } }
+      end
+    end
+
+
+    it '#render_view as success' do
+      post :update, correct: true, id: 1
+      expect(response.body).to eq('Update OK')
+      expect(response.code).to eq('200')
+    end
+
+    it '#render_fail_view as fail' do
+      post :update, id: 1
+      expect(response.body).to eq('Update Fail')
+      expect(response.code).to eq('422')
+      post :update, id: 2
+      expect(response.body).to eq('Update access deny')
+      expect(response.code).to eq('401')
+    end
+  end
+end

metadata

@@ -1,41 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: light_operations
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Pawel Niemczyk
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.2
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
@@ -154,9 +196,11 @@ files:
 - Rakefile
 - lib/light_operations.rb
 - lib/light_operations/core.rb
+- lib/light_operations/flow.rb
 - lib/light_operations/version.rb
 - light_operations.gemspec
 - spec/lib/core_spec.rb
+- spec/lib/flow_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/pniemczyk/light_operations
 licenses:
@@ -178,10 +222,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Light operations
 test_files:
 - spec/lib/core_spec.rb
+- spec/lib/flow_spec.rb
 - spec/spec_helper.rb