riveter 0.0.1

data/lib/riveter/enquiry_routes.rb

@@ -0,0 +1,69 @@
+require 'action_dispatch'
+
+module Riveter
+  module EnquiryRoutes
+
+    #
+    # defines a route for the given enquiry
+    #
+    # by convention, the word "enquiry" is omitted
+    # from the name of the enquiry
+    #
+    # options include:
+    #
+    #   :path            overrides the path used.
+    #                    by default it is "<enquiry>_enquiry".
+    #                    E.g. for :active_portfolios the path is 'active_portfolios'
+    #
+    #   :controller      overrides the controller used.
+    #                    by default it is "<enquiry>_enquiry_controller"
+    #
+    #   :as              overrides the name of the route generated.
+    #                    by default it is "<enquiry>_enquiry"
+    #
+    #   :action          overrides the action name.
+    #                    by default is is ":index"
+    #
+    # E.g.
+    #
+    #   enquiry :active_portfolios
+    #
+    #     creates a route 'active_portfolios' named `active_portfolios_enquiry` to the
+    #     `ActivePortfoliosEnquiryController` controller for the 'index' action
+    #
+    #   enquiry :active_portfolios, :as => 'recent_portfolios'
+    #
+    #     creates a route 'active_portfolios' named `recent_portfolios` to the
+    #     `ActivePortfoliosEnquiryController` controller for the 'index' action
+    #
+    #   enquiry :active_portfolios, :path => '/all_your_portfolios'
+    #
+    #     creates a route 'all_your_portfolios' named `active_portfolios_enquiry` to the
+    #     `ActivePortfoliosEnquiryController` controller for the 'index' action
+    #
+    #   enquiry :active_portfolios, :controller => 'my_portfolios_controller'
+    #
+    #     creates a route 'active_portfolios' named `active_portfolios_enquiry` to the
+    #     `MyPortfoliosController` controller for the 'index' action
+    #
+    def enquiry(enquiry, options={})
+      raise ArgumentError, 'Expects a symbol for the enquiry.' unless enquiry.is_a?(Symbol)
+
+      path = options.delete(:path) || enquiry.to_s
+      action = options.delete(:action) || :index
+
+      options = {
+        :controller => :"#{enquiry}_enquiry",
+        :as         => :"#{enquiry}_enquiry"
+      }.merge(options)
+
+      # define GET 'index' route
+      get path, options.merge(:action => action)
+
+      # define POST 'index' route
+      post path, options.merge(:action => action, :as => nil)
+    end
+  end
+end
+
+ActionDispatch::Routing::Mapper.send :include, Riveter::EnquiryRoutes

data/lib/riveter/enumerated.rb

@@ -0,0 +1,107 @@
+module Riveter
+  module Enumerated
+    extend ActiveSupport::Concern
+
+    included do
+
+      const_names = self.constants(false)
+      const_values = const_names.collect {|name| self.const_get(name) }
+
+      # create hashes for decoding names and values
+      const_value_lookup ||= const_names.inject({}) {|list, name|
+        list[name] = self.const_get(name)
+        list
+      }.with_indifferent_access
+
+      const_name_lookup ||= const_names.inject({}) {|list, name|
+        list[self.const_get(name)] = name
+        list
+      }
+
+      # define helper methods
+
+      # returns an array of the constant names as symbols
+      define_singleton_method :names do
+        const_names
+      end
+
+      # returns an array of constant values
+      define_singleton_method :all do
+        const_values
+      end
+
+      # given a value, returns the name of the constant as a symbol
+      define_singleton_method :name_for do |value|
+        const_name_lookup[value]
+      end
+
+      # given a name, returns the value of the constant
+      # accepts a string or symbol for the constants name
+      define_singleton_method :value_for do |name|
+        const_value_lookup[name]
+      end
+
+      # returns the human name for the given constant name or value
+      # it uses the locale to lookup the translation
+      # and defaults to the capitalized name of the constant
+      define_singleton_method :human_name_for do |name_or_value, options={}|
+        const_name = name_or_value.is_a?(Symbol) ?
+                      name_or_value :
+                      value_for(name_or_value)
+
+        options = {
+          :scope => [:enums, self.to_s.underscore],
+          :default => const_name.to_s.titleize
+        }.merge!(options)
+
+        I18n.translate(const_name, options)
+      end
+
+      # defines the "All" constant
+      # which is array like object that can be used to loop
+      # over the set of constants and provides some helper methods
+      self.const_set :All, Enumeration.new(self, const_values)
+
+      # for use within form select inputs
+      define_singleton_method :collection do
+        self.const_get(:All).collect {|m| [m.human, m.value] }
+      end
+    end
+
+    module ClassMethods
+      def human(options={})
+        options = {
+          :scope => [:enums, self.to_s.underscore],
+          :default => self.name.titleize
+        }.merge!(options)
+
+        I18n.translate(:human, options)
+      end
+    end
+
+    class Enumeration < Array
+      attr_reader :enum
+
+      delegate :names, :values, :human, :to => :enum
+
+      def initialize(enum, values)
+        @enum = enum
+        super(values.collect {|value| Member.new(enum, value) })
+      end
+    end
+
+    class Member
+      attr_reader :name, :value
+
+      def initialize(enum, value)
+        @enum = enum
+        @name = enum.name_for(value)
+        @value = value
+      end
+
+      def human(options={})
+        @enum.human_name_for(name, options)
+      end
+    end
+  end
+end

data/lib/riveter/errors.rb

@@ -0,0 +1,11 @@
+module Riveter
+  class UnknownAttributeError < NoMethodError
+    attr_reader :instance, :attribute
+
+    def initialize(instance, attribute)
+      @instance = instance
+      @attribute = attribute.to_s
+      super("unknown attribute: #{attribute}")
+    end
+  end
+end

data/lib/riveter/form_builder_extensions.rb

@@ -0,0 +1,21 @@
+require 'action_view'
+
+module Riveter
+  module FormBuilderExtensions
+
+    def search
+      submit I18n.translate(:search, :scope => [:forms]), :name => :search
+    end
+
+    def reset
+      submit I18n.translate(:reset, :scope => [:forms]), :name => :reset
+    end
+
+  end
+end
+
+module ActionView::Helpers
+  class FormBuilder
+    include Riveter::FormBuilderExtensions
+  end
+end

data/lib/riveter/hash_with_dependency.rb

@@ -0,0 +1,12 @@
+module Riveter
+  # See http://ruby-doc.org/stdlib-2.0/libdoc/tsort/rdoc/TSort.html for details
+  class HashWithDependency < Hash
+    include TSort
+
+    alias tsort_each_node each_key
+
+    def tsort_each_child(node, &block)
+      fetch(node).each(&block)
+    end
+  end
+end

data/lib/riveter/presenter.rb

@@ -0,0 +1,73 @@
+module Riveter
+  module Presenter
+    module Object
+      extend ActiveSupport::Concern
+
+      def to_presenter(klass)
+        raise ArgumentError, 'klass argument cannot be nil' if klass.nil?
+        raise ArgumentError, "#{klass} is not a valid presenter class" unless klass <= Presenter::Base
+        klass.new(self)
+      end
+    end
+
+    module Enumerator
+      extend ActiveSupport::Concern
+
+      def with_presenter(klass, &block)
+        raise ArgumentError, 'klass argument cannot be nil' if klass.nil?
+        raise ArgumentError, "#{klass} is not a valid presenter class" unless klass <= Presenter::Base
+        return to_enum(__method__, klass) unless block_given?
+
+        ##
+        # some magic!
+        # assuming that this method is used within the view
+        # the block which is supplied will be in the scope of the view
+        # therefore, getting it's binding and evaluating self will
+        # get us the view object
+        ##
+        view = block.binding.eval('self')
+        is_a_view = view.is_a?(ActionView::Base)
+
+        self.each do |item|
+          yield klass.new(item, (is_a_view ? view : nil))
+        end
+      end
+    end
+
+    class Base < SimpleDelegator
+      def item
+        __getobj__
+      end
+
+      def initialize(item, view=nil)
+        super(item)
+        @view = view
+      end
+
+      def method_missing(method, *args, &block)
+        return super if @view.nil?
+
+        if respond_to_without_view?(method)
+          super
+        elsif @view.respond_to?(method)
+          @view.send(method, *args, &block)
+        else
+          super
+        end
+      end
+
+      def respond_to_with_view?(method)
+        respond_to_without_view?(method) || (!@view.nil? && @view.respond_to?(method))
+      end
+      alias_method_chain :respond_to?, :view
+    end
+  end
+end
+
+class Object
+  include Riveter::Presenter::Object
+end
+
+class Enumerator
+  include Riveter::Presenter::Enumerator
+end

data/lib/riveter/query.rb

@@ -0,0 +1,45 @@
+module Riveter
+  module Query
+    extend ActiveSupport::Concern
+
+    attr_reader :query_filter
+    attr_reader :options
+    attr_reader :relation
+
+    def initialize(query_filter, options={})
+      @query_filter = query_filter
+      @options = options
+      @relation = build_relation(@query_filter)
+    end
+
+    # enumerates the resultset in batch mode
+    def find_each(&block)
+      relation.find_each_with_order(&block) if has_data?
+    end
+
+    # override if necessary in derived classes
+    def has_data?
+      @has_data ||= relation.count() > 0
+    end
+
+  protected
+
+    # override in derived classes
+    def build_relation(filter)
+
+      #
+      # use the given filter to add conditions
+      # to produce an ActiveRelation as the query
+      #
+      # E.g. filter.page #=> Model.all.page(filter.page)
+      #
+
+      raise NotImplementedError
+    end
+
+    # helper class
+    class Base
+      include Query
+    end
+  end
+end

data/lib/riveter/query_filter.rb

@@ -0,0 +1,22 @@
+module Riveter
+  module QueryFilter
+    extend ActiveSupport::Concern
+
+    included do
+      include Riveter::Attributes
+
+      class << self
+        alias_method :filter_name, :model_name
+
+        def i18n_scope
+          :query_filters
+        end
+      end
+    end
+
+    # helper class
+    class Base
+      include QueryFilter
+    end
+  end
+end

data/lib/riveter/rails/engine.rb

@@ -0,0 +1,6 @@
+module Riveter
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/riveter/rails/railtie.rb

@@ -0,0 +1,50 @@
+module Riveter
+  module Rails
+    class Railtie < ::Rails::Railtie
+      initializer 'riveter.initialize' do
+        require 'riveter/form_builder_extensions'
+        require 'riveter/command_routes'
+        require 'riveter/enquiry_routes'
+      end
+
+      initializer 'riveter.set_autoload_paths', :before => :set_autoload_paths do |app|
+        config = app.config
+
+        # add paths to auto load path
+        %w{
+          commands
+          enquiries
+          enums
+          presenters
+          queries
+          query_filters
+          services
+          workers
+        }.each do |path|
+          config.autoload_paths += %W(#{config.root}/app/#{path})
+          config.autoload_paths += %W(#{config.root}/app/#{path}/concerns)
+        end
+      end
+
+      initializer "riveter.load_services" do |app|
+        ActiveSupport.on_load :after_initialize do |app|
+          #
+          # services need to be loaded manually since they aren't referenced
+          # directly and therefore cannot be autoloaded
+          #
+          # also, when the class is loaded, it registers itself as the service for a command
+          #
+          Dir[File.join(app.config.root, 'app', 'services', '**/*_service.rb')].each {|file| require file }
+        end
+      end
+
+      console do
+        # TODO
+      end
+
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |file|  load file }
+      end
+    end
+  end
+end

data/lib/riveter/service.rb

@@ -0,0 +1,45 @@
+module Riveter
+  module Service
+    extend ActiveSupport::Concern
+    include AssociatedTypeRegistry
+
+    module ClassMethods
+      def register_as_handler_for(command_type)
+        register_type self, command_type
+      end
+    end
+
+    # override in derived classes
+    def perform(command, *args)
+
+      #
+      # use the given command's attributes to perform the action
+      #
+
+      raise NotImplementedError
+    end
+
+    # helper class
+    class Base
+      include Service
+
+      class << self
+        def inherited(klass)
+          #
+          # attempt to get the name of the command
+          # from the derived classes name and register
+          # it as the service handler for that command
+          #
+          # e.g. CreatePortfolioCommand ==> CreatePortfolioService
+          #
+          command_type = klass.name.gsub(/Service$/, 'Command').constantize rescue nil
+          register_type klass, command_type unless command_type.nil?
+        end
+      end
+
+      # NOTE: associated commands will be registered on this class!
+      # use the respective resolve methods with the Riveter::Service::Base in this case
+
+    end
+  end
+end

data/lib/riveter/spec_helper.rb

@@ -0,0 +1,55 @@
+# helpers for use in testing
+
+module Mock
+  class Block
+    def to_proc
+      lambda { |*args| call(*args) }
+    end
+
+    # the call method must be provided by in specs
+    # E.g. using `expect(mock_block_instance).to receive(:call)` to assert that the "block" gets called
+    def call
+      raise NotImplementedError, "Expecting `call` method to have an expectation defined to assert."
+    end
+  end
+
+  module Valid
+    def valid?
+      true
+    end
+  end
+
+  module Invalid
+    def valid?
+      false
+    end
+  end
+
+  class ValidCommand < Riveter::Command::Base
+    include Valid
+  end
+
+  class InvalidCommand < Riveter::Command::Base
+    include Invalid
+  end
+
+  class ValidQueryFilter < Riveter::QueryFilter::Base
+    include Valid
+  end
+
+  class InvalidQueryFilter < Riveter::QueryFilter::Base
+    include Invalid
+  end
+
+  class QueryWithData < Riveter::Query::Base
+    def has_data?
+      true
+    end
+  end
+
+  class QueryWithoutData < Riveter::Query::Base
+    def has_data?
+      false
+    end
+  end
+end

data/lib/riveter/version.rb

@@ -0,0 +1,3 @@
+module Riveter
+  VERSION = "0.0.1"
+end

data/lib/riveter/worker.rb

@@ -0,0 +1,20 @@
+module Riveter
+  module Worker
+    extend ActiveSupport::Concern
+
+    included do
+      # TODO: define mixed in methods
+    end
+
+    module ClassMethods
+      # TODO: define class methods
+    end
+
+    # TODO: define instance methods
+
+    # helper class
+    class Base
+      include Worker
+    end
+  end
+end

data/lib/riveter.rb

@@ -0,0 +1,47 @@
+require "riveter/version"
+
+require 'active_model'
+require 'active_record'
+require 'active_support'
+require 'validates_timeliness'
+
+require 'active_support/core_ext'
+require 'active_support/inflector'
+require 'active_support/inflector'
+
+module Riveter
+  autoload :AttributeDefaultValues, 'riveter/attribute_default_values'
+  autoload :AssociatedTypeRegistry, 'riveter/associated_type_registry'
+  autoload :Attributes, 'riveter/attributes'
+  autoload :Command, 'riveter/command'
+  autoload :CommandController, 'riveter/command_controller'
+  autoload :Enquiry, 'riveter/enquiry'
+  autoload :EnquiryController, 'riveter/enquiry_controller'
+  autoload :Enumerated, 'riveter/enumerated'
+  autoload :HashWithDependency, 'riveter/hash_with_dependency'
+  autoload :Presenter, 'riveter/presenter'
+  autoload :Query, 'riveter/query'
+  autoload :QueryFilter, 'riveter/query_filter'
+  autoload :Service, 'riveter/service'
+  autoload :Worker, 'riveter/worker'
+end
+
+# add autoload's for validators
+module ActiveModel
+  module Validations
+    autoload :BooleanessValidator, 'riveter/booleaness_validator'
+    autoload :EmailValidator, 'riveter/email_validator'
+  end
+end
+
+require 'riveter/errors'
+require 'riveter/core_extensions'
+
+# Rails bits...
+require 'riveter/rails/railtie' if defined?(::Rails::Railtie)
+require 'riveter/rails/engine' if defined?(::Rails)
+
+# include locale in load path
+Dir[File.join(File.dirname(__FILE__), '*.yml')].each do |file|
+  I18n.load_path << file
+end

data/riveter.gemspec

@@ -0,0 +1,40 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'riveter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'riveter'
+  spec.version       = Riveter::VERSION
+  spec.authors       = ['Chris Stefano']
+  spec.email         = ['virtualstaticvoid@gmail.com']
+  spec.summary       = %q{Provides several useful patterns, packaged in a gem, for use in Rails.}
+  spec.description   = %q{Provides several useful patterns, such as Enumerated, Command, Enquiry, Query, QueryFilter, Service, Presenter and Worker, packaged in a gem, for use in Rails and other Ruby applications.}
+  spec.homepage      = 'https://github.com/virtualstaticvoid/riveter'
+  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.required_ruby_version = '>= 2.0.0'
+
+  spec.add_dependency 'railties', '~> 4.0.0'
+  spec.add_dependency 'actionpack'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'activerecord'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'validates_timeliness'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rails', '~> 4.0.5'
+  spec.add_development_dependency 'haml-rails'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'shoulda-matchers', '~> 2.6.1'
+  spec.add_development_dependency 'ammeter'
+  spec.add_development_dependency 'simplecov', '~> 0.7.1'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+end