actionmodel 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3c41a9b0d2b50d220634760063ca98c2e926e7a7
+  data.tar.gz: 19a460bf9c6e2c17089154187607343a4ffa9bd7
+SHA512:
+  metadata.gz: de1fed006aaf3ba649d3ba0d974176f8b79d152cd1ee7aba84e1695dc78061ef9a1188add3b68cc0df29ef505f77733680f31e48348cae576b99f86a11c4159f
+  data.tar.gz: 9cda7b375acc0ab89a4b69df631f06c9d438cb37b715e6471dc591ed22b6dee95e8f87f90516af023b2540d77ead5afb2c54cc234a94c86cded86fd90d8c1231

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+coverage

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in actionmodel.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,10 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/actionmodel/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('lib/actionmodel.rb')  { 'spec' }
+  watch('spec/spec_helper.rb')  { 'spec' }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Max Kazarin
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# ActionModel
+
+[![Build Status](https://travis-ci.org/maxkazar/actionmodel.png?branch=master)](https://travis-ci.org/maxkazar/actionmodel) [![Coverage Status](https://coveralls.io/repos/maxkazar/actionmodel/badge.png?branch=master)](https://coveralls.io/r/maxkazar/actionmodel?branch=master) [![Code Climate](https://codeclimate.com/repos/52f8ba86e30ba04a62003cdb/badges/84d12fb736e9a2d3331b/gpa.png)](https://codeclimate.com/repos/52f8ba86e30ba04a62003cdb/feed)
+
+Clean up complex model logic using action.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'actionmodel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install actionmodel
+
+## Usage
+
+If you have complex model class it can be split into clear model class and actions. For example, `Post` model
+
+```ruby
+class Post
+  scope :search, ->(title) { where tile: title }
+  scope :page, ->(page, size) { ... }
+
+  def add_tags(tags)
+    ...
+  end
+
+  def remove_tags(tags)
+    ...
+  end
+end
+```
+
+can be split into pretty `Post` model and actions: `searchable`, `pageable`, `tagable`
+
+```ruby
+class Post
+  acts_as_searchable :title, ignorecase: true
+  acts_as :pageable, :tagable
+end
+```
+
+Searchable action
+
+```ruby
+module Actions
+  module Searchable
+    extend ActiveSupport::Concern
+
+    included do
+      scope :search, ->(text) do
+        actions[:searchable].fields.each do |field, options|
+          # field is title
+          # options is { ignorecase: true }
+          ...
+        end
+      end
+    end
+  end
+end
+```
+
+Pageable action
+
+```ruby
+module Actions
+  module Pageable
+    extend ActiveSupport::Concern
+
+    included do
+      scope :page, ->(page, size) { ... }
+    end
+  end
+end
+```
+
+Tagable action
+
+```ruby
+module Actions
+  module Tagable
+    def add_tags(tags)
+      ...
+    end
+
+    def remove_tags(tags)
+      ...
+    end
+  end
+end
+```
+
+Action is a ruby module and can be included into model class with DSL `acts_as` very easy
+
+```ruby
+acts_as :action1, :action2, ...
+```  
+
+or with fields and options
+
+```ruby
+acts_as_action1 :field1, :field2, option1: 1, options2: 2
+```  
+
+Inside action module you can get fields and options through actions method.
+
+```ruby
+module Actions
+  module Action1
+    # class method actions
+
+    # get action fields
+    actions(:action1).field.keys
+
+    # iterate each field with options
+    actions(:action1).field.each do |field, options|
+      ...
+    end
+
+    def do_somthing
+      # instance method actions do the same
+    end
+  end
+end
+```
+
+ActionModel works with rails folder structure. Actions can be stored into some folders:
+
+* local action folder path is `/app/model/post`
+* global action folder path is `/app/models/actions` and `/lib/actions`
+
+Local action has more priority then global. When actions with the same name are stored in both folder, then local action will be included.
+It helps to override some action for specific model.
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/actionmodel/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/actionmodel.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'actionmodel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'actionmodel'
+  spec.version       = ActionModel::VERSION
+  spec.authors       = ['Max Kazarin']
+  spec.email         = ['maxkazargm@gmail.com']
+  spec.summary       = %q{Model actions extender.}
+  spec.description   = %q{ActionModel helps to structure model logic with actions.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'coveralls'
+end

data/lib/actionmodel.rb

@@ -0,0 +1,5 @@
+require 'actionmodel/version'
+require 'actionmodel/concern'
+
+module ActionModel
+end

data/lib/actionmodel/concern.rb

@@ -0,0 +1,100 @@
+require 'active_support/core_ext/array/extract_options'
+require 'active_support/core_ext/string/inflections'
+require 'active_support/core_ext/object/blank'
+require 'active_support/concern'
+require 'actionmodel/context'
+
+module ActionModel
+  module Concern
+    extend ActiveSupport::Concern
+
+    # Return actions context hash for model instance.
+    def actions
+      self.class.actions
+    end
+
+    module ClassMethods
+
+      # Add actions to model.
+      #
+      # Add single action to model
+      #
+      #   class Post
+      #     acts_as :searchable
+      #     ...
+      #   end
+      #
+      # Add actions to model
+      #
+      #   class Post
+      #     acts_as :searchable, :viewable
+      #     ...
+      #   end
+      #
+      # Actions can be added with options. Options applied for each action
+      #
+      #   class Post
+      #     acts_as :searchable, ignorecase: true
+      #     ...
+      #   end
+      def acts_as(*args)
+        options = args.extract_options!
+
+        args.each { |action_name| include_action action_name, options }
+      end
+
+      # Return actions context hash for model class.
+      def actions
+        @actions ||= {}
+      end
+
+      # Add action to model.
+      #
+      #
+      # @example Add historyable action
+      #   class Rank
+      #     acts_as_historyable :value, :boost, autofill: true
+      #     ...
+      #   end
+      def method_missing(method, *args, &block)
+        action = method[/^acts_as_(.+)/, 1]
+        if action.nil?
+          super method, *args, &block
+        else
+          include_action *args.unshift(action)
+        end
+      end
+
+      private
+
+      # Include action into model
+      def include_action(*args)
+        return if args.empty?
+
+        action_name = args.shift.to_sym
+
+        action = action_module action_name
+        unless action
+          raise 'Action %1$s is not found in [%2$s::%3$s, Actions::%3$s].' %
+                    [ action_name, self.name.demodulize, action_name.to_s.camelize ]
+        end
+
+        find_or_create_action(action_name).update *args
+
+        include action unless include? action
+      end
+
+      # Find or create action by action name
+      def find_or_create_action(action_name)
+        actions[action_name] ||= ActionModel::Context.new
+      end
+
+      # Return action module by action name
+      def action_module(action)
+        "#{self.name.demodulize}::#{action.to_s.camelize}".safe_constantize ||
+            "Actions::#{action.to_s.camelize}".safe_constantize
+      end
+    end
+  end
+end
+

data/lib/actionmodel/context.rb

@@ -0,0 +1,24 @@
+module ActionModel
+  class Context
+    def options
+      @options ||= {}
+    end
+
+    def fields
+      @fields ||= {}
+    end
+
+    def update(*args)
+      options = args.extract_options!
+
+      if args.empty?
+        self.options.merge! options
+      else
+        args.each do |field|
+          fields[field.to_sym] ||= {}
+          fields[field.to_sym].merge! options
+        end
+      end
+    end
+  end
+end

data/lib/actionmodel/version.rb

@@ -0,0 +1,3 @@
+module ActionModel
+  VERSION = '0.0.1'
+end

data/spec/concern_spec.rb

@@ -0,0 +1,109 @@
+require 'spec_helper'
+
+describe ActionModel::Concern do
+  let(:model) { Class.new { include ActionModel::Concern } }
+
+  before do
+    allow(model).to receive(:name).and_return 'Post'
+    model.public_class_method :include_action, :find_or_create_action, :action_module
+  end
+
+  describe '#actions' do
+    it 'return class actions' do
+      expect(model.new.actions).to eq model.actions
+    end
+  end
+
+  describe '.acts_as' do
+    it 'include action' do
+      expect(model).to receive(:include_action).with :searchable, {}
+      model.acts_as :searchable
+    end
+
+    it 'include action with options' do
+      expect(model).to receive(:include_action).with :searchable, { ignorecase: true }
+      model.acts_as :searchable, ignorecase: true
+    end
+  end
+
+  describe '.method_missing' do
+    context 'without action method' do
+      it 'call class method' do
+        expect { model.some_method }.to raise_error
+      end
+    end
+
+    context 'with action method' do
+      it 'config action' do
+        expect(model).to receive(:include_action).with 'searchable', :name, ignorecase: true
+        model.acts_as_searchable :name, ignorecase: true
+      end
+    end
+  end
+
+  describe '.include_action' do
+    context 'action module exists' do
+      let(:action) { double :action }
+
+      before do
+        allow(model).to receive(:action_module).and_return action
+        allow(model).to receive(:include?).and_return false
+      end
+
+      it 'update action context' do
+        allow(model).to receive(:include)
+        expect_any_instance_of(ActionModel::Context).to receive(:update)
+        model.include_action :searchable
+      end
+
+      it 'update action context with options' do
+        allow(model).to receive(:include)
+        expect_any_instance_of(ActionModel::Context).to receive(:update).with(ignorecase: true)
+        model.include_action :searchable, ignorecase: true
+      end
+
+      it 'include action module' do
+        expect(model).to receive(:include).with action
+        model.include_action :searchable
+      end
+    end
+
+    context 'action module does not exists' do
+      before { allow(model).to receive(:action_module).and_return nil }
+
+      it 'raise exception' do
+        expect { model.include_action :unknownable }.to raise_error RuntimeError, 'Action unknownable is not found in [Post::Unknownable, Actions::Unknownable].'
+      end
+    end
+  end
+
+  describe '.action_module' do
+    let(:action) { "#{model.name.demodulize}::Knownable" }
+
+    context 'when a model action exists' do
+      before { allow(ActiveSupport::Inflector).to receive(:safe_constantize).with(action).and_return action }
+
+      subject { model.action_module :knownable }
+
+      it { should eq action }
+    end
+
+    context 'when a global action exists' do
+      let(:action) { 'Actions::Knownable' }
+
+      before { allow(ActiveSupport::Inflector).to receive(:safe_constantize).and_return nil, action }
+
+      subject { model.action_module :knownable }
+
+      it { should eq action }
+    end
+
+    context 'when the action model is not exist' do
+      before { allow(ActiveSupport::Inflector).to receive(:safe_constantize).and_return nil }
+
+      subject { model.action_module(:unknownable) }
+
+      it { should be_nil }
+    end
+  end
+end

data/spec/context_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe ActionModel::Context do
+  let(:context) { ActionModel::Context.new }
+
+  describe '#update' do
+    it 'update action options' do
+      context.update disabled: true
+      expect(context.options).to eq disabled: true
+    end
+
+    it 'update action fields' do
+      context.update :name, :email
+      expect(context.fields.keys).to eq [:name, :email]
+    end
+
+    it 'update action fields options' do
+      context.update :name, :email, ignorecase: true
+      expect(context.fields).to eq({ name: {ignorecase: true}, email: {ignorecase: true} })
+    end
+
+    context 'when action context has options' do
+      before { context.options[:disabled] = true }
+
+      it 'update action options' do
+        context.update disabled: false, inverse: true
+        expect(context.options).to eq disabled: false, inverse: true
+      end
+    end
+
+    context 'when action context has field' do
+      before { context.fields[:name] = {ignorecase: true} }
+
+      it 'update action field options' do
+        context.update :name, :email, ignorecase: false
+        expect(context.fields).to eq({ name: {ignorecase: false}, email: {ignorecase: false} })
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'actionmodel'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+
+  config.expect_with(:rspec) { |c| c.syntax = :expect }
+end

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: actionmodel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Max Kazarin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ActionModel helps to structure model logic with actions.
+email:
+- maxkazargm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- actionmodel.gemspec
+- lib/actionmodel.rb
+- lib/actionmodel/concern.rb
+- lib/actionmodel/context.rb
+- lib/actionmodel/version.rb
+- spec/concern_spec.rb
+- spec/context_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Model actions extender.
+test_files:
+- spec/concern_spec.rb
+- spec/context_spec.rb
+- spec/spec_helper.rb
+has_rdoc: