lev 2.0.5 → 2.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDA3ZTU4MzVlZmQxZDAyYzc3NzUyMmMxNmU5MmQ3MWM1ODE5MDhmZQ==
+  data.tar.gz: !binary |-
+    NzkyYzQ5NDRmMDk1NzgzNmY1YzhhM2Q2OGIwOGVkNzAyNDU1ZmIzNQ==
+SHA512:
+  metadata.gz: !binary |-
+    NzhhZmQ3ZDdjM2IxMTRiNGQ2NGI3ZjgyNWQ5NTUzNWY2MmVkYWJlMDUyOTE2
+    MzU3MTMzZmNjNGIxYmQ2ZDQ2YjdhMDNiMmU2MTAyZDNjYWE5YjNmMjU2ZWFi
+    NjFlMGM3ZDM1NzQ4YjZjNTMwZjhmOGE0OGNhNzgwN2FiYzVhOTU=
+  data.tar.gz: !binary |-
+    Njc3OTEwZjJhZjQyNTZhMDM2ZGFiYjc0ZGMyN2IzMjA5NTFiNTk5ZTgxNWYx
+    YTNlMGEyODQ5Y2Y1ZWUyMGUwZmI2ZGI4MzhiYmYyYjUwYjZmNDg5Y2QzMDQ3
+    MDU1MzRlMWJlZDBmNWE3MjY3OTBmYzg2NGYwMzU0MTUyODBiZWU=

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format progress
+--debug

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    lev (2.0.5)
+    lev (2.1.0)
       actionpack (>= 3.0)
       active_attr
       activemodel (>= 3.0)
@@ -13,33 +13,33 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (4.0.3)
-      activesupport (= 4.0.3)
-      builder (~> 3.1.0)
-      erubis (~> 2.7.0)
+    actionpack (4.1.1)
+      actionview (= 4.1.1)
+      activesupport (= 4.1.1)
       rack (~> 1.5.2)
       rack-test (~> 0.6.2)
-    active_attr (0.8.2)
-      activemodel (>= 3.0.2, < 4.1)
-      activesupport (>= 3.0.2, < 4.1)
-    activemodel (4.0.3)
-      activesupport (= 4.0.3)
-      builder (~> 3.1.0)
-    activerecord (4.0.3)
-      activemodel (= 4.0.3)
-      activerecord-deprecated_finders (~> 1.0.2)
-      activesupport (= 4.0.3)
-      arel (~> 4.0.0)
-    activerecord-deprecated_finders (1.0.3)
-    activesupport (4.0.3)
-      i18n (~> 0.6, >= 0.6.4)
-      minitest (~> 4.2)
-      multi_json (~> 1.3)
+    actionview (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+    active_attr (0.8.3)
+      activemodel (>= 3.0.2, < 4.2)
+      activesupport (>= 3.0.2, < 4.2)
+    activemodel (4.1.1)
+      activesupport (= 4.1.1)
+      builder (~> 3.1)
+    activerecord (4.1.1)
+      activemodel (= 4.1.1)
+      activesupport (= 4.1.1)
+      arel (~> 5.0.0)
+    activesupport (4.1.1)
+      i18n (~> 0.6, >= 0.6.9)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
       thread_safe (~> 0.1)
-      tzinfo (~> 0.3.37)
-    arel (4.0.2)
-    atomic (1.1.15)
-    builder (3.1.4)
+      tzinfo (~> 1.1)
+    arel (5.0.1.20140414130214)
+    builder (3.2.2)
     columnize (0.3.6)
     debugger (1.6.2)
       columnize (>= 0.3.1)
@@ -49,10 +49,10 @@ GEM
     debugger-ruby_core_source (1.2.3)
     diff-lcs (1.2.4)
     erubis (2.7.0)
-    hashie (2.0.5)
+    hashie (2.1.1)
     i18n (0.6.9)
-    minitest (4.7.5)
-    multi_json (1.8.4)
+    json (1.8.1)
+    minitest (5.3.4)
     rack (1.5.2)
     rack-test (0.6.2)
       rack (>= 1.0)
@@ -66,14 +66,14 @@ GEM
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.14.3)
     sqlite3 (1.3.9)
-    thread_safe (0.2.0)
-      atomic (>= 1.1.7, < 2)
+    thread_safe (0.3.4)
     transaction_isolation (1.0.3)
       activerecord (>= 3.0.11)
     transaction_retry (1.0.2)
       activerecord (>= 3.0.11)
       transaction_isolation (>= 1.0.2)
-    tzinfo (0.3.38)
+    tzinfo (1.2.0)
+      thread_safe (~> 0.1)
 
 PLATFORMS
   ruby

data/README.md

@@ -28,6 +28,7 @@ Handlers...
 1. Help you verify that the calling user is authorized to run the handler
 2. Provide ways to validate incoming parameters in a very ActiveModel-like way (even when the parameters are not associated with a model)
 3. Integrate will with basic routines
+4. Map one-to-one with controller actions; by keeping the logic in each controller action encapsulated in a Handler, the code becomes independently-testable and also prevents the controller from being "fat" with 7 different actions all containing disparate logic touching different models.
 
 In a Lev-oriented Rails app, controllers are just responsible for connecting routes to Handlers.  In fact, controller methods just end up being calls to ```handle_with(MyHandler)```, ```handle_with``` being a helper method provided by Lev.  
 
@@ -46,6 +47,20 @@ When using Lev, model classes have the following responsibilities:
 
 The result of the principles above and below, model classes end up being very small.  This is good because a lot of code depends on the models and having the be small normally means they are also stable.
 
+## Naming Conventions
+
+As mentioned above, a handler is intended to replace the logic in one controller action.  As such, one convention that works well is to name a handler based on the controller name and the action name, e.g. for the `ProductsController#show` action, we would have a handler named `ProductsShow`.  
+
+Routines on the other hand are more or less glorified functions that work with multiple models to get something done, so we typically start their names with verbs, e.g. `CreateUser`, `SetPassword`, `ConfirmEmail`, etc.
+
+## Differences between Lev and Rails' Concerns
+
+Both Lev and Concerns remove lines of code from models, but the major difference between the two is that with Concerns, the code still lives logically in the models whereas code in Lev is completely outside of and separate from the models.  
+
+Lev's routines (and handlers) know about models, but the models don't know anything about nor are they dependent on the code in routines.  This makes the models simpler and more stable (a Good Thing).  
+
+Since a Concern's code is essentially embedded in model code, if that Concern breaks it can potentially break other unrelated features, something that can't happen with routines.  
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/lib/lev/handler.rb

@@ -31,8 +31,10 @@ module Lev
   #      instance objects based on the params.
   #   2) Call the class method "paramify" to declare, cast, and validate parts of
   #      the params hash. The first argument to paramify is the key in params
-  #      which points to a hash of params to be paramified.  The block passed to
-  #      paramify looks just like the guts of an ActiveAttr model.
+  #      which points to a hash of params to be paramified.  If this first argument
+  #      is unspecified (or specified as `:paramify`, a reserved symbol), the entire 
+  #      params hash will be paramified.  The block passed to paramify looks just 
+  #      like the guts of an ActiveAttr model.
   #      
   #      When the incoming params includes :search => {:type, :terms, :num_results}
   #      the Handler class would look like:
@@ -122,7 +124,8 @@ module Lev
         call(options)
       end
 
-      def paramify(group, options={}, &block)
+      def paramify(group = :paramify, options={}, &block)
+
         method_name = "#{group.to_s}_params"
         variable_sym = "@#{method_name}".to_sym
 
@@ -145,11 +148,15 @@ module Lev
         end
 
         # Define the "#{group}_params" method to get the paramifier 
-        # instance wrapping the params
+        # instance wrapping the params.  Choose the subset of params
+        # based on the group, choosing all params if the default group
+        # is used.
+
         define_method method_name.to_sym do
           if !instance_variable_get(variable_sym)
+            params_subset = group == :paramify ? params : params[group]
             instance_variable_set(variable_sym, 
-                                  self.class.paramify_classes[group].new(params[group]))
+                                  self.class.paramify_classes[group].new(params_subset))
           end
           instance_variable_get(variable_sym)
         end

data/lib/lev/version.rb

@@ -1,3 +1,3 @@
 module Lev
-  VERSION = "2.0.5"
+  VERSION = "2.1.0"
 end

data/spec/paramify_handler_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe ParamifyHandlerA do
+  it 'should error out on badly formatted params' do
+    result = ParamifyHandlerA.handle(params: {terms: {type: 'blah'}})
+    errors = result.errors.collect { |error| error.translate }
+    expect(errors).to eq(['Type is not valid'])
+  end
+end
+
+describe ParamifyHandlerB do
+  it 'should error out on badly formatted ungrouped params' do
+    result = ParamifyHandlerB.handle(params: {type: 'blah'})
+    errors = result.errors.collect { |error| error.translate }
+    expect(errors).to eq(['Type is not valid'])
+  end
+
+  it 'should provide access to top-level params' do
+    result = ParamifyHandlerB.handle(params: {type: 'Name', value: 2})
+    errors = result.errors.collect { |error| error.translate }
+    expect(result.outputs.success).to eq true
+  end
+end

data/spec/support/paramify_handler_a.rb

@@ -0,0 +1,17 @@
+class ParamifyHandlerA
+
+  include Lev::Handler
+
+  paramify :terms do 
+    attribute :type, type: String
+    validates :type, presence: true,
+                            inclusion: { in: %w(Name Username Any),
+                                         message: "is not valid" }
+  end
+
+protected
+
+  def authorized?; true; end
+  def handle; end
+
+end

data/spec/support/paramify_handler_b.rb

@@ -0,0 +1,22 @@
+class ParamifyHandlerB
+
+  include Lev::Handler
+
+  paramify do 
+    attribute :type, type: String
+    validates :type, presence: true,
+                     inclusion: { in: %w(Name Username Any),
+                                  message: "is not valid" }
+
+    attribute :value, type: Integer
+  end
+
+protected
+
+  def authorized?; true; end
+
+  def handle
+    outputs[:success] = true if paramify_params.value == 2
+  end
+
+end

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: lev
 version: !ruby/object:Gem::Version
-  version: 2.0.5
-  prerelease: 
+  version: 2.1.0
 platform: ruby
 authors:
 - JP Slavinsky
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-03 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -38,7 +34,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -46,7 +41,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -54,7 +48,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -62,7 +55,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: transaction_isolation
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -70,7 +62,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -78,7 +69,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: transaction_retry
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -86,7 +76,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -94,7 +83,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: active_attr
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -102,7 +90,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -110,7 +97,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -118,7 +104,6 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -126,7 +111,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -134,7 +118,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -142,7 +125,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -150,7 +132,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -158,7 +139,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -166,7 +146,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -174,7 +153,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -182,7 +160,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -190,7 +167,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: debugger
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -198,7 +174,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -243,52 +218,51 @@ files:
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/outputs_spec.rb
+- spec/paramify_handler_spec.rb
 - spec/routine_spec.rb
 - spec/spec_helper.rb
 - spec/sprocket_handler_spec.rb
 - spec/sprocket_spec.rb
 - spec/support/create_sprocket.rb
+- spec/support/paramify_handler_a.rb
+- spec/support/paramify_handler_b.rb
 - spec/support/sprocket.rb
 - spec/support/sprocket_handler.rb
 homepage: http://github.com/lml/lev
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2969297821958856203
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -2969297821958856203
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Ride the rails but don't touch them.
 test_files:
 - spec/create_sprocket_spec.rb
 - spec/deep_merge_spec.rb
 - spec/outputs_spec.rb
+- spec/paramify_handler_spec.rb
 - spec/routine_spec.rb
 - spec/spec_helper.rb
 - spec/sprocket_handler_spec.rb
 - spec/sprocket_spec.rb
 - spec/support/create_sprocket.rb
+- spec/support/paramify_handler_a.rb
+- spec/support/paramify_handler_b.rb
 - spec/support/sprocket.rb
 - spec/support/sprocket_handler.rb