riveter 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9b51c150059867905f381fcd4a303bcae0464683
+  data.tar.gz: e2aa27934831b4e6066b63e6c7edc7577beed1cb
+SHA512:
+  metadata.gz: 72454455538bb878d56831daf6ec8281e749e0f2118852f4107d2191d2bc656412e8f38e031722a9a9b1be7f8d6df14d77d8250e749c3571104dacfd23908269
+  data.tar.gz: 952dc079df4c947453484ab371d8fe1920368d111e23d7c66c0912a3383d05ea8ebae7375b1ef36902cfc01c6c2ce0ec6ed71285947c5ce0d9d797a49c73ee73

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+riveter

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 2.1.1
+  - 2.1.2
+
+script: 'bundle exec rake spec'
+
+notifications:
+  email:
+    recipients:
+      - virtualstaticvoid@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,147 @@
+PATH
+  remote: .
+  specs:
+    riveter (0.0.1)
+      actionpack
+      activemodel
+      activerecord
+      activesupport
+      railties (~> 4.0.0)
+      validates_timeliness
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.0.5)
+      actionpack (= 4.0.5)
+      mail (~> 2.5.4)
+    actionpack (4.0.5)
+      activesupport (= 4.0.5)
+      builder (~> 3.1.0)
+      erubis (~> 2.7.0)
+      rack (~> 1.5.2)
+      rack-test (~> 0.6.2)
+    activemodel (4.0.5)
+      activesupport (= 4.0.5)
+      builder (~> 3.1.0)
+    activerecord (4.0.5)
+      activemodel (= 4.0.5)
+      activerecord-deprecated_finders (~> 1.0.2)
+      activesupport (= 4.0.5)
+      arel (~> 4.0.0)
+    activerecord-deprecated_finders (1.0.3)
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    ammeter (1.0.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-rails (>= 2.2)
+    arel (4.0.2)
+    builder (3.1.4)
+    byebug (2.7.0)
+      columnize (~> 0.3)
+      debugger-linecache (~> 1.2)
+    coderay (1.1.0)
+    columnize (0.8.9)
+    debugger-linecache (1.2.0)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    haml (4.0.5)
+      tilt
+    haml-rails (0.5.3)
+      actionpack (>= 4.0.1)
+      activesupport (>= 4.0.1)
+      haml (>= 3.1, < 5.0)
+      railties (>= 4.0.1)
+    hike (1.2.3)
+    i18n (0.6.9)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    method_source (0.8.2)
+    mime-types (1.25.1)
+    minitest (4.7.5)
+    multi_json (1.10.0)
+    polyglot (0.3.4)
+    pry (0.9.12.6)
+      coderay (~> 1.0)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    pry-byebug (1.3.2)
+      byebug (~> 2.7)
+      pry (~> 0.9.12)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (4.0.5)
+      actionmailer (= 4.0.5)
+      actionpack (= 4.0.5)
+      activerecord (= 4.0.5)
+      activesupport (= 4.0.5)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.0.5)
+      sprockets-rails (~> 2.0.0)
+    railties (4.0.5)
+      actionpack (= 4.0.5)
+      activesupport (= 4.0.5)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.3.1)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    rspec-rails (2.14.2)
+      actionpack (>= 3.0)
+      activemodel (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    shoulda-matchers (2.6.1)
+      activesupport (>= 3.0.0)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    slop (3.5.0)
+    sprockets (2.11.0)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sprockets-rails (2.0.1)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      sprockets (~> 2.8)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    timeliness (0.3.7)
+    treetop (1.4.15)
+      polyglot
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.39)
+    validates_timeliness (3.0.14)
+      timeliness (~> 0.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ammeter
+  bundler (~> 1.5)
+  haml-rails
+  pry
+  pry-byebug
+  rails (~> 4.0.5)
+  rake
+  riveter!
+  rspec-rails
+  shoulda-matchers (~> 2.6.1)
+  simplecov (~> 0.7.1)

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Chris Stefano
+virtualstaticvoid@gmail.com
+
+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,77 @@
+# Riveter [![Build Status](https://secure.travis-ci.org/virtualstaticvoid/riveter.png?branch=master)](http://travis-ci.org/virtualstaticvoid/riveter) [![Code Climate](https://codeclimate.com/github/virtualstaticvoid/riveter.png)](https://codeclimate.com/github/virtualstaticvoid/riveter)
+
+Provides several useful patterns, packaged in a gem, for use in Rails.
+Includes generators to help you improve consistency in your applications.
+
+* Enumerated
+* Query
+* QueryFilter
+* Enquiry
+* EnquiryController
+* Command
+* CommandController
+* Service
+* Presenter
+* Worker
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'riveter'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install riveter
+
+## Usage
+
+Riverter provides generators for creating boilerplate code necessary for each pattern.
+
+To get the list of available generators, execute:
+
+    $ rails generate
+
+The generator names are prefixed with `riveter`.
+
+E.g.
+
+To generate an enquiry controller, query filter, query, views and associated specs, execute:
+
+    $ rails generate riveter:enquiry SomeEnquiryName filter1:string filter2:integer:required
+
+This will create a query with `filter1` string attribute and `filter2` integer attribute, a query, a controller and views:
+
+      invoke  enquiry_controller
+      create    app/controllers/my_enquiry_name_enquiry_controller.rb
+       route    enquiry :my_enquiry_name
+      invoke    haml
+      create      app/views/my_enquiry_name_enquiry/index.html.haml
+      invoke    rspec
+      create      spec/controllers/my_enquiry_name_enquiry_controller_spec.rb
+      invoke  query
+      create    app/queries/my_enquiry_name_query.rb
+      invoke    rspec
+      create      spec/queries/my_enquiry_name_query_spec.rb
+      invoke  query_filter
+      create    app/query_filters/my_enquiry_name_query_filter.rb
+      invoke    rspec
+      create      spec/query_filters/my_enquiry_name_query_filter_spec.rb
+      create  app/enquiries/my_enquiry_name_enquiry.rb
+      invoke  rspec
+      create    spec/enquiries/my_enquiry_name_enquiry_spec.rb
+
+## Contributing
+
+1. Fork it ( http://github.com/virtualstaticvoid/riveter/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
+
+## License
+Released under the MIT License.  See the [LICENSE](LICENSE.txt) file for further details.

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/app/helpers/riveter/command_form_helper.rb

@@ -0,0 +1,15 @@
+module Riveter
+  module CommandFormHelper
+    def command_form_for(command, options={}, &block)
+      command_class_name = command.class.name.underscore
+      options = {
+        :as => command_class_name.gsub(/_command$/, ''),
+        :url => command_class_name.gsub(/_command$/, '')
+      }.merge(options)
+
+      respond_to?(:simple_form_for) ?
+        simple_form_for(command, options, &block) :
+        form_for(command, options, &block)
+    end
+  end
+end

data/app/helpers/riveter/enquiry_form_helper.rb

@@ -0,0 +1,16 @@
+module Riveter
+  module EnquiryFormHelper
+    def enquiry_form_for(enquiry, options={}, &block)
+      enquiry_class_name = enquiry.class.name.underscore
+      options = {
+        :as => enquiry_class_name.gsub(/_enquiry$/, ''),
+        :url => enquiry_class_name.gsub(/_enquiry$/, ''),
+        :method => :get
+      }.merge(options)
+
+      respond_to?(:simple_form_for) ?
+        simple_form_for(enquiry.query_filter, options, &block) :
+        form_for(enquiry.query_filter, options, &block)
+    end
+  end
+end

data/app/helpers/riveter/query_filter_form_helper.rb

@@ -0,0 +1,16 @@
+module Riveter
+  module QueryFilterFormHelper
+    def query_filter_form_for(query_filter, options={}, &block)
+      query_filter_class_name = query_filter.class.name.underscore
+      options = {
+        :as => query_filter_class_name.gsub(/_query_filter$/, ''),
+        :url => query_filter_class_name,
+        :method => :get
+      }.merge(options)
+
+      respond_to?(:simple_form_for) ?
+        simple_form_for(query_filter, options, &block) :
+        form_for(query_filter, options, &block)
+    end
+  end
+end

data/config/locales/forms.en.yml

@@ -0,0 +1,25 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  forms:
+    search: Search
+    reset: Reset

data/config/locales/validators.en.yml

@@ -0,0 +1,26 @@
+# Files in the config/locales directory are used for internationalization
+# and are automatically loaded by Rails. If you want to use locales other
+# than English, add the necessary files in this directory.
+#
+# To use the locales, use `I18n.t`:
+#
+#     I18n.t 'hello'
+#
+# In views, this is aliased to just `t`:
+#
+#     <%= t('hello') %>
+#
+# To use a different locale, set it with `I18n.locale`:
+#
+#     I18n.locale = :es
+#
+# This would use the information in config/locales/es.yml.
+#
+# To learn more, please read the Rails Internationalization guide
+# available at http://guides.rubyonrails.org/i18n.html.
+
+en:
+  errors:
+    messages:
+      booleaness: is not valid
+      email: is not valid

data/init.rb

@@ -0,0 +1,25 @@
+# Copyright (c) 2014 Chris Stefano
+# virtualstaticvoid@gmail.com
+#
+# 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.
+
+require 'riveter'

data/lib/generators/erb/TODO

@@ -0,0 +1 @@
+Create generators and templates for ERB implementation

data/lib/generators/haml/command_controller/command_controller_generator.rb

@@ -0,0 +1,56 @@
+module Haml
+  module Generators
+    class CommandControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Command'
+
+      argument :new_action,
+               :type => :string,
+               :default => 'new',
+               :banner => 'new_action'
+
+      argument :command_attributes,
+               :type => :array,
+               :default => [],
+               :banner => "[name[:type[:required]] name[:type[:required]]]"
+
+      def initialize(args, *options)
+        super
+        parse_command_attributes!
+      end
+
+      def create_template_file
+        template 'new.html.haml', File.join('app/views', class_path, "#{file_name}_command", "#{new_action}.html.haml")
+      end
+
+    protected
+
+      def parse_command_attributes!
+        self.command_attributes = (command_attributes || []).map do |attribute|
+          # expected in the form "name", "name:type" or "name:type:required"
+          parts = attribute.split(':')
+          name = parts.first.underscore
+          type = ((parts.length > 1) ? parts[1] : 'string')
+
+          additional_options = case type.to_sym
+            when :integer, :decimal, :boolean, :date, :time, :datetime
+              ", :as => :#{type}"
+            when :enum
+              ", :collection => #{name.titleize}.collection"
+            when :model
+              ", :collection => #{name.titleize}.all"
+            else
+              ''
+            end
+
+          OpenStruct.new(
+            :name => name,
+            :type => type,
+            :inject_options => additional_options
+          )
+        end
+      end
+    end
+  end
+end

data/lib/generators/haml/command_controller/templates/new.html.haml

@@ -0,0 +1,26 @@
+%h1 <%= class_name %>Command
+%p Find me in '<%= args.first %>'.
+
+= command_form_for(@command, :html => {:class => 'form-vertical'}) do |f|
+<% if defined?(SimpleForm) -%>
+  = f.error_notification
+<% else -%>
+  - if @command.errors.any?
+    #error_explanation
+      %h2= "#{pluralize(@command.errors.count, "error")} prohibited performing this action:"
+      %ul
+        - @command.errors.full_messages.each do |msg|
+          %li= msg
+<%end -%>
+
+  .form-inputs
+<% if command_attributes.any? -%>
+<% command_attributes.each do |attribute| -%>
+    = f.input :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% else -%>
+    -# TODO: provide inputs for each attribute
+<% end -%>
+
+  .form-actions
+    = f.submit

data/lib/generators/haml/enquiry_controller/enquiry_controller_generator.rb

@@ -0,0 +1,56 @@
+module Haml
+  module Generators
+    class EnquiryControllerGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('../templates', __FILE__)
+
+      check_class_collision :suffix => 'Enquiry'
+
+      argument :action_name,
+               :type => :string,
+               :default => 'index',
+               :banner => 'action_name'
+
+      argument :filter_attributes,
+               :type => :array,
+               :default => [],
+               :banner => "[attribute[:type[:required]] attribute[:type[:required]]]"
+
+      def initialize(args, *options)
+        super
+        parse_filter_attributes!
+      end
+
+      def create_template_file
+        template 'index.html.haml', File.join('app/views', class_path, "#{file_name}_enquiry", "#{action_name}.html.haml")
+      end
+
+    protected
+
+      def parse_filter_attributes!
+        self.filter_attributes = (filter_attributes || []).map do |attribute|
+          # expected in the form "name", "name:type" or "name:type:required"
+          parts = attribute.split(':')
+          name = parts.first.underscore
+          type = ((parts.length > 1) ? parts[1] : 'string')
+
+          additional_options = case type.to_sym
+            when :integer, :decimal, :boolean, :date, :time, :datetime
+              ", :as => :#{type}"
+            when :enum
+              ", :collection => #{name.titleize}.collection"
+            when :model
+              ", :collection => #{name.titleize}.all"
+            else
+              ''
+            end
+
+          OpenStruct.new(
+            :name => name,
+            :type => type,
+            :inject_options => additional_options
+          )
+        end
+      end
+    end
+  end
+end

data/lib/generators/haml/enquiry_controller/templates/index.html.haml

@@ -0,0 +1,57 @@
+%h1 <%= class_name %>Enquiry
+%p Find me in '<%= args.first %>'.
+
+.filter
+
+  %h2 Search
+
+    = enquiry_form_for(@enquiry, :html => {:class => 'form-horizontal'}) do |f|
+<% if defined?(SimpleForm) -%>
+      = f.error_notification
+<% else -%>
+      - if f.object.errors.any?
+        #error_explanation
+          %h2= "#{pluralize(f.object.errors.count, "error")} prohibited performing this enquiry:"
+          %ul
+            - f.object.errors.full_messages.each do |msg|
+              %li= msg
+<%end -%>
+
+      .form-inputs
+<% if filter_attributes.any? -%>
+<% filter_attributes.each do |attribute| -%>
+        = f.input :<%= attribute.name %><%= attribute.inject_options %>
+<% end -%>
+<% else -%>
+        -# TODO: provide inputs for each attribute
+<% end -%>
+
+      .form-actions
+        = f.submit
+        = f.reset
+
+.results
+
+  %h2 Listing <%= class_name.underscore.humanize.pluralize %>
+
+  %table.table.table-bordered
+    %tr
+      %th Col1
+      %th Col2
+
+    - unless @enquiry.has_data?
+      %tr
+        %td(colspan="2")
+          .no-data-message Invalid criteria or no items found...
+    - else
+      - @enquiry.find_each do |result|
+        %tr
+          %td= result.col1
+          %td= result.col2
+
+  - if @enquiry.has_data?
+<% if defined?(Kaminari) -%>
+    = paginate @enquiry.query.relation
+<% else -%>
+    -# TODO: provide pagination outputs against `@enquiry.query.relation`
+<% end -%>