action_conductor 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bb81761460837305b560a193300326b3bd21bdb6
+  data.tar.gz: 7bc65a7a2c70a4136c7a43c0aef1b83095ec07e6
+SHA512:
+  metadata.gz: f0bac2b3dcd4e2fb36b2fb3c95153762c25425efb6083f340a917efd658ed87892d10f861932ef9541170200d3a1f7c25ec5055da48e48766d307d8e9e344d62
+  data.tar.gz: 14bc14905a03f5d32d812ea891cf2eb3fb93df0c6925fd1a1126a4e8f61d34cdfa2516151d2bdd9ef50ae0d84c639fc1339bc02a1ef3824961bade742897b368

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+*.gem

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Adam Cuppy
+
+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,122 @@
+# Action Conductor
+[![Build Status](https://travis-ci.org/acuppy/conductor.svg?branch=master)](https://travis-ci.org/acuppy/conductor)[![Code Climate](https://codeclimate.com/github/acuppy/conductor/badges/gpa.svg)](https://codeclimate.com/github/acuppy/conductor)
+
+DRY-up Rails Controllers with conductors
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'action_conductor'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+Define a Conductor in `app/conductors`
+
+```ruby
+class PagesConductor < ActionConductor::Base
+
+  # pass it a value directly
+  export :page, "Hello World"
+
+  # delegate to a block for compilation
+  export :meta do
+    "some computed value"
+  end
+
+  # optionally pass arguments from the computed action to the computed value
+  export :foo do |args|
+    "some computed value with arguments"
+  end
+
+  # blocks are executed in the context of the conductor instance, so...
+  export :bar do
+    bar_conductor
+  end
+
+  # ... delegates to ...
+  def bar_conductor
+  end
+end
+```
+
+Bind it to a Rails Controller
+
+```ruby
+class PagesController < ApplicationController
+  conductor :pages
+  # ...
+end
+```
+
+Export computed values via `exports`
+```ruby
+class PagesController < ApplicationController
+  # ...
+  def show
+    @page = exports
+  end
+end
+```
+or export multiple computed values
+
+```ruby
+class PagesController < ApplicationController
+  # ...
+  def show
+    @page, @meta = exports # => exports in the established order
+  end
+end
+```
+explicitly declare which exports to export, and in which order
+```ruby
+class PagesController < ApplicationController
+  # ...
+  def show
+    @meta, @page = exports(:meta, :page)
+  end
+end
+```
+Pass arguments to the export block
+```ruby
+class PagesController < ApplicationController
+  # ...
+  def show
+    @address = exports(:address, "111 Main St.")
+  end
+end
+
+class PagesConductor < ActionConductor::Base
+  export :address do |street|
+    "#{street} Medford, OR 97501"
+  end
+end
+```
+
+In case there is a competing `exports` method on the controller, you can access it through
+the `conductor` instance
+
+```ruby
+class PagesController < ApplicationController
+  # ...
+  def show
+    @foo = conductor.exports(:foo)
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/conductor/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 a new Pull Request

data/Rakefile

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

data/action_conductor.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'action_conductor/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "action_conductor"
+  spec.version       = ActionConductor::VERSION
+  spec.authors       = ["Adam Cuppy"]
+  spec.email         = ["adam@codingzeal.com"]
+  spec.summary       = %q{DRY-up Rails controllers by leveraging interchangeable conductors to export data}
+  spec.homepage      = "https://github.com/acuppy/action_conductor"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '~> 4.0', '>= 4.0.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'rspec', '~> 3.0', '>= 3.0.0'
+end

data/lib/action_conductor.rb

@@ -0,0 +1,13 @@
+require "action_conductor/version"
+require "action_conductor/errors/undefined_inherited_method"
+require "action_conductor/errors/undefined_conductor"
+require "action_conductor/base"
+require "action_conductor/definition"
+require "action_conductor/collection"
+require "action_conductor/action_runner"
+require "action_conductor/exporter"
+require "action_conductor/integrations/action_controller"
+require "action_conductor/deferred_export"
+
+module ActionConductor
+end

data/lib/action_conductor/action_runner.rb

@@ -0,0 +1,29 @@
+module ActionConductor
+  class ActionRunner
+
+    def initialize(options={})
+      @controller = options.fetch(:controller)
+      @conductors = options.fetch(:conductors)
+    end
+
+    def export(*options)
+      @exported ||= {}
+      @exported[options] ||= begin
+        exported = export_with_options(options)
+        exported.length == 1 ? exported.first : exported
+      end
+    end
+
+    private
+
+    attr_accessor :controller, :conductors
+
+    def export_with_options(options)
+      initialized_conductors.flat_map { |c| c.export(*options) }
+    end
+
+    def initialized_conductors
+      @initialized_conductors ||= Collection.new(conductors.map { |c| c.new(controller) })
+    end
+  end
+end

data/lib/action_conductor/base.rb

@@ -0,0 +1,33 @@
+module ActionConductor
+  class Base
+    def initialize(controller)
+      @controller = controller
+      @params     = controller.params
+    end
+
+    def export(*args)
+      Exporter.new(self).export(args)
+    end
+
+    def exports
+      self.class.exports
+    end
+
+    def export_keys
+      exports.map(&:id)
+    end
+
+    protected
+
+    attr_reader :controller, :params
+
+    def self.export(id, value=nil, &block)
+      callback = value.nil? ? block : Proc.new { value }
+      exports << DeferredExport.new(id, &callback)
+    end
+
+    def self.exports
+      @exports ||= []
+    end
+  end
+end

data/lib/action_conductor/collection.rb

@@ -0,0 +1,30 @@
+require "delegate"
+
+module ActionConductor
+  class Collection < SimpleDelegator
+
+    attr_reader :conductors
+
+    def initialize(conductors = Array.new)
+      @conductors = conductors
+      super(@conductors)
+    end
+
+    def with_handle(handle)
+      conductors = selected_conductors_by_handle(handle)
+
+      if conductors.empty?
+        raise "No conductors with the handle: #{handle}"
+      else
+        conductors
+      end
+    end
+
+    private
+
+    def selected_conductors_by_handle(handle)
+      return self if handle.nil?
+      self.class.new(conductors.select { |c| c.handle = handle })
+    end
+  end
+end

data/lib/action_conductor/deferred_export.rb

@@ -0,0 +1,17 @@
+module ActionConductor
+  class DeferredExport
+    attr_reader :id
+
+    def initialize(id, &callback)
+      @id, @callback = id, callback
+    end
+
+    def export(context, export_value=nil)
+      context.instance_exec(export_value, &callback)
+    end
+
+    private
+
+    attr_reader :context, :callback
+  end
+end

data/lib/action_conductor/definition.rb

@@ -0,0 +1,31 @@
+module ActionConductor
+  class Definition
+    attr_reader :handle, :class_name
+
+    def initialize(configs={})
+      @handle     = configs.fetch(:handle)
+      @actions    = configs.fetch(:actions, [])
+      @class_name = configs.fetch(:class_name, @handle)
+    end
+
+    def klass
+      @conductor_klass ||= conductor_klass
+    end
+
+    def actions
+      @actions ||= Set.new(@actions)
+    end
+
+    private
+
+    def conductor_klass
+      Object.const_get(conductor_klass_name)
+    rescue NameError
+      raise UndefinedConductor.new(conductor_klass_name)
+    end
+
+    def conductor_klass_name
+      "#{class_name.to_s.camelize}Conductor"
+    end
+  end
+end

data/lib/action_conductor/errors/undefined_conductor.rb

@@ -0,0 +1,7 @@
+module ActionConductor
+  class UndefinedConductor < StandardError
+    def initialize(conductor_klass_name)
+      super "No conductor named #{conductor_klass_name} is defined"
+    end
+  end
+end

data/lib/action_conductor/errors/undefined_inherited_method.rb

@@ -0,0 +1,7 @@
+module ActionConductor
+  class UndefinedInheritedMethod < StandardError
+    def initialize(method)
+      super("#{method} should have been defined by the conductor")
+    end
+  end
+end

data/lib/action_conductor/exporter.rb

@@ -0,0 +1,71 @@
+module ActionConductor
+  class Exporter
+
+    attr_reader :conductor
+
+    def initialize(conductor)
+      @conductor = conductor
+    end
+
+    def export(arguments)
+      @arguments = arguments
+      output.length == 1 ? output.first : output
+    end
+
+    private
+
+    attr_reader :arguments, :context
+
+    def output
+      @output ||= begin
+        enumerable_exports do |deferred, exports|
+          exports << export_deferred(deferred)
+        end
+      end
+    end
+
+    def enumerable_exports(&block)
+      selected_exports.to_a.each_with_object([], &block)
+    end
+
+    def export_deferred(deferred)
+      deferred.export(conductor, requested_export_value)
+    end
+
+    def selected_exports
+      requested_export_keys.map do |key|
+        exports.find { |export| export.id == key }
+      end
+    end
+
+    def exports
+      conductor.exports
+    end
+
+    def export_keys
+      conductor.export_keys
+    end
+
+    def requested_export_keys
+      key_value(arguments)[0]
+    end
+
+    def requested_export_value
+      key_value(arguments)[1]
+    end
+
+    def key_value(args)
+      return [export_keys, nil]   if empty? args
+      return [[args[0]], args[1]] if setter? args
+      return [args, nil]
+    end
+
+    def empty?(args)
+      args.empty?
+    end
+
+    def setter?(args)
+      args[0].is_a? Symbol and !args[1].is_a? Symbol
+    end
+  end
+end

data/lib/action_conductor/integrations/action_controller.rb

@@ -0,0 +1,59 @@
+module ActionConductor
+  module ActionController
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def conductor(handle, options={})
+        register_conductor define_conductor(handle, options)
+      end
+
+      private
+
+      def register_conductor(definition)
+        conductors << definition.klass
+
+        define_method "#{definition.handle}_conductor" do
+          self.conductor(definition.handle)
+        end
+      end
+
+      def define_conductor(handle, options={})
+        only_actions   = options.fetch(:only)   { self.action_methods.to_a }
+        except_actions = options.fetch(:except) { [] }
+        actions        = only_actions - except_actions
+
+        Definition.new(handle: handle, actions: actions)
+      end
+
+      def conductors
+        @conductors ||= Collection.new
+      end
+    end
+
+    def conductor(handle=nil)
+      @action_runner ||= {}
+      @action_runner[handle] ||=
+        ActionRunner.new( controller: self, conductors: conductors.with_handle(handle))
+    end
+
+    def exports(*args)
+      conductor.export(*args)
+    end
+
+    private
+
+    def conductors
+      _conductors = self.class.send(:conductors)
+
+      if _conductors.empty?
+        raise "No conductors have been defined"
+      else
+        _conductors
+      end
+    end
+  end
+end
+
+if defined? ActionController::Base
+  ActionController::Base.send :include, ActionConductor::ActionController
+end

data/lib/action_conductor/version.rb

@@ -0,0 +1,3 @@
+module ActionConductor
+  VERSION = "0.2.0"
+end

data/lib/generators/conductor_generator.rb

@@ -0,0 +1,19 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module ActionConductor
+  module Generators
+    class ConductorGenerator < ::Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path("../templates", __FILE__)
+
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+
+      def copy_migration
+        migration_template 'migration.rb', "db/migrate/create_.rb"
+      end
+    end
+  end
+end

data/spec/action_conductor/base_spec.rb

@@ -0,0 +1,9 @@
+require "spec_helper"
+require "action_conductor/base"
+
+module ActionConductor
+  describe Base do
+    let(:controller) { double :controller, params: {} }
+    subject(:base) { Base.new(controller) }
+  end
+end

data/spec/action_conductor/collection_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+
+module ActionConductor
+  describe Collection do
+    let(:conductor) {  }
+    describe "#with_handle" do
+      context "no conductor found" do
+        pending
+      end
+
+      context "when conductors are found" do
+        pending
+      end
+    end
+  end
+end

data/spec/action_conductor/definition_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+require "action_conductor/definition"
+
+class HandleNameConductor
+end
+
+class FooBarConductor
+end
+
+module ActionConductor
+  describe Definition do
+    shared_examples_for "a definition class" do
+      let(:class_name) { nil }
+      let(:actions) { ["foo", "bar"] }
+      let(:arguments) do
+        {
+          handle: handle,
+          actions: actions
+        }
+      end
+
+      subject(:definition) { described_class.new arguments }
+
+      before do
+        arguments.update(class_name: class_name) if class_name
+      end
+
+      it { expect(definition.handle).to eq handle }
+      it { expect(definition.klass).to eq conductor }
+      it { expect(definition.actions).to eq actions }
+    end
+
+    context "when conductor class doesn't exist" do
+      let(:handle) { "not_defind" }
+
+      subject(:definition) { described_class.new handle: handle }
+
+      it { expect { definition.klass }.to raise_error UndefinedConductor }
+    end
+
+    context "when class_name is assumed" do
+      it_behaves_like "a definition class" do
+        let(:handle)  { "handle_name" }
+        let(:conductor) { HandleNameConductor }
+      end
+    end
+
+    context "when class_name is defined" do
+      it_behaves_like "a definition class" do
+        let(:handle)     { "handle_name" }
+        let(:class_name) { "foo_bar" }
+        let(:conductor)    { FooBarConductor }
+      end
+    end
+  end
+end

data/spec/action_conductor/integrations/action_controller_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe DummyController, "Integration ActionController::Base" do
+  describe ".conductor" do
+    subject(:controller) { DummyController.new }
+
+    before(:all) { DummyController.class_eval { conductor :test_multi_export } }
+
+    it { expect(subject).to respond_to :conductor }
+    it { expect(subject).to respond_to :exports }
+
+    context "when exporting" do
+      before  { controller.index }
+
+      ["@foo", "@foo_a", "@foo_b"].each do |var|
+        context var do
+          subject { controller.instance_variable_get var.to_sym }
+          it { is_expected.to eq "Hello World" }
+        end
+      end
+
+      ["@bar", "@bar_a", "@bar_b"].each do |var|
+        context var do
+          subject { controller.instance_variable_get var.to_sym }
+          it { is_expected.to eq "Goodbye Moon" }
+        end
+      end
+
+      context "@meme" do
+        subject { controller.instance_variable_get :@meme }
+        it { is_expected.to eq "Me me" }
+      end
+
+      context "@omg" do
+        subject { controller.instance_variable_get :@omg }
+        it { is_expected.to eq "LMAO..." }
+      end
+
+      context "@my_method" do
+        subject { controller.instance_variable_get :@my_method }
+        it { is_expected.to eq "conductor method called" }
+      end
+    end
+
+    context "without explicitly defining the conductor" do
+    end
+  end
+end

data/spec/action_conductor_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe ActionConductor do
+  it 'has a version number' do
+    expect(ActionConductor::VERSION).not_to be nil
+  end
+
+  it "binds to ActionController::Base" do
+    expect(ActionController::Base.ancestors).to include(ActionConductor::ActionController)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,40 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "rails"
+require "action_controller"
+require 'action_conductor'
+
+class DummyController < ActionController::Base
+  def params
+    { action: :index }
+  end
+
+  def index
+    @foo = exports(:foo)
+    @bar = conductor.export(:bar)
+    @foo_a, @bar_a, @meme = conductor.export
+    @bar_b, @foo_b = conductor.export(:bar, :foo)
+    @omg = conductor.export(:omg, "LMAO")
+    @my_method = conductor.export(:my_method)
+  end
+end
+
+class TestMultiExportConductor < ActionConductor::Base
+  export :foo, "Hello World"
+  export :bar, "Goodbye Moon"
+
+  export :meme do
+    "Me me"
+  end
+
+  export :omg do |lol|
+    "#{lol}..."
+  end
+
+  export :my_method do
+    my_method
+  end
+
+  def my_method
+    "conductor method called"
+  end
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: action_conductor
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Adam Cuppy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: 
+email:
+- adam@codingzeal.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- action_conductor.gemspec
+- lib/action_conductor.rb
+- lib/action_conductor/action_runner.rb
+- lib/action_conductor/base.rb
+- lib/action_conductor/collection.rb
+- lib/action_conductor/deferred_export.rb
+- lib/action_conductor/definition.rb
+- lib/action_conductor/errors/undefined_conductor.rb
+- lib/action_conductor/errors/undefined_inherited_method.rb
+- lib/action_conductor/exporter.rb
+- lib/action_conductor/integrations/action_controller.rb
+- lib/action_conductor/version.rb
+- lib/generators/conductor_generator.rb
+- spec/action_conductor/base_spec.rb
+- spec/action_conductor/collection_spec.rb
+- spec/action_conductor/definition_spec.rb
+- spec/action_conductor/integrations/action_controller_spec.rb
+- spec/action_conductor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/acuppy/action_conductor
+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.2
+signing_key: 
+specification_version: 4
+summary: DRY-up Rails controllers by leveraging interchangeable conductors to export
+  data
+test_files:
+- spec/action_conductor/base_spec.rb
+- spec/action_conductor/collection_spec.rb
+- spec/action_conductor/definition_spec.rb
+- spec/action_conductor/integrations/action_controller_spec.rb
+- spec/action_conductor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: