adequate_exposure 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2550e167e6ed3284a239f703242d97e1ca110559
-  data.tar.gz: 5a3404cfb7a7914ce36c4b8c005cb488b4f4b663
+  metadata.gz: b45371ec2f76686959ecea9daafa48bfdcbff365
+  data.tar.gz: 7b9d2f20e7b8817d26aa546cfa540f40cc9bd9e0
 SHA512:
-  metadata.gz: d5a89302e07b4663297cdc26f352384b28020428daa32727be6bf6b2e69046a0469f452600b7f571a07b5ac19dac7553deb695f2cfbaf20a2fa8e652cc862c6e
-  data.tar.gz: 2d10aed16e6a24554a01642058c1715986c654a2089815ba8fea1e42d69d57a2752cb9f3f9f66d4af8283c58df8e6ae7ae3ae8af8780070eaac371ad70698f04
+  metadata.gz: 7b5a55b1ed6f423981c3a8763da33f5b753f463ef1f95e0c3057f01b72fc77b1a5cd0b9b8c501c28c8ab9279b77df637bf9ecaf6e01676b18e8716063cf4d9b6
+  data.tar.gz: 94fc24e721c06a468fec3a88371b625d7ea7325b7f4c3ea3892bea709b92098ffb8432754a07f9c39f5fcad97610cfce0760976b45e06ccc2db8a5607ee7a99d

data/.gitignore

@@ -14,9 +14,11 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+vendor/bundle
 tmp
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+gemfiles/*.lock

data/.travis.yml

@@ -1,3 +1,21 @@
+before_install:
+  - gem install bundler
+
+gemfile:
+  - gemfiles/rails_4.0.gemfile
+  - gemfiles/rails_4.1.gemfile
+  - gemfiles/rails_4.2.gemfile
+  - gemfiles/rails_5.0.gemfile
+
 rvm:
   - 2.0
   - 2.1
+  - 2.2
+  - 2.3
+
+matrix:
+  exclude:
+  - rvm: 2.0
+    gemfile: gemfiles/rails_5.0.gemfile
+  - rvm: 2.1
+    gemfile: gemfiles/rails_5.0.gemfile

data/Appraisals

@@ -0,0 +1,20 @@
+appraise "rails-5.0" do
+  gem "railties", "~> 5.0.0"
+  gem "activesupport", "~> 5.0.0"
+end
+
+appraise "rails-4.2" do
+  gem "railties", "~> 4.2.0"
+  gem "activesupport", "~> 4.2.0"
+end
+
+appraise "rails-4.1" do
+  gem "railties", "~> 4.1.0"
+  gem "activesupport", "~> 4.1.0"
+end
+
+appraise "rails-4.0" do
+  gem "railties", "~> 4.0.0"
+  gem "activesupport", "~> 4.0.0"
+end
+

data/Gemfile

@@ -2,6 +2,7 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rspec-rails", "~> 3.0"
+gem "appraisal",   "~> 2.1"
+gem "pry",         "~> 0.10"
 gem "rake",        "~> 10.3"
-gem "pry"
+gem "rspec-rails", "~> 3.4"

data/Rakefile

@@ -1,6 +1,9 @@
 require "bundler/gem_tasks"
+require "bundler/setup"
 require "rspec/core/rake_task"
+require "appraisal/task"
 
+Appraisal::Task.new
 RSpec::Core::RakeTask.new
 
 task default: :spec

data/adequate_exposure.gemspec

@@ -14,6 +14,6 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = "~> 2.0"
 
-  spec.add_dependency "railties",      "~> 4.0"
-  spec.add_dependency "activesupport", "~> 4.0"
+  spec.add_dependency "railties",      ">= 4.0", "< 6"
+  spec.add_dependency "activesupport", ">= 4.0", "< 6"
 end

data/gemfiles/rails_4.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.1"
+gem "pry", "~> 0.10"
+gem "rake", "~> 10.3"
+gem "rspec-rails", "~> 3.4"
+gem "railties", "~> 4.0.0"
+gem "activesupport", "~> 4.0.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.1.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.1"
+gem "pry", "~> 0.10"
+gem "rake", "~> 10.3"
+gem "rspec-rails", "~> 3.4"
+gem "railties", "~> 4.1.0"
+gem "activesupport", "~> 4.1.0"
+
+gemspec :path => "../"

data/gemfiles/rails_4.2.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.1"
+gem "pry", "~> 0.10"
+gem "rake", "~> 10.3"
+gem "rspec-rails", "~> 3.4"
+gem "railties", "~> 4.2.0"
+gem "activesupport", "~> 4.2.0"
+
+gemspec :path => "../"

data/gemfiles/rails_5.0.gemfile

@@ -0,0 +1,12 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "appraisal", "~> 2.1"
+gem "pry", "~> 0.10"
+gem "rake", "~> 10.3"
+gem "rspec-rails", "~> 3.4"
+gem "railties", "~> 5.0.0"
+gem "activesupport", "~> 5.0.0"
+
+gemspec :path => "../"

data/lib/adequate_exposure/attribute.rb

@@ -2,20 +2,42 @@ module AdequateExposure
   class Attribute
     attr_reader :name, :fetch, :ivar_name
 
+    # Public: Initialize an Attribute
+    #
+    # options - Hash of options for the Attribute
+    #           :name      - The String name of the Attribute instance
+    #           :fetch     - The Proc fetch to calculate
+    #                        the value of the Attribute instance.
+    #                        This is only called if the attribute's
+    #                        instance variable is not defined.
+    #           :ivar_name - The String instance variable name that
+    #                        is associated with the attribute.
     def initialize(options)
       @name = options.fetch(:name)
       @fetch = options.fetch(:fetch)
       @ivar_name = options.fetch(:ivar_name)
     end
 
+    # Public: The getter method for the Attribute.
+    #
+    # Returns the name of the Attribute as a Symbol.
     def getter_method_name
       name.to_sym
     end
 
+    # Public: The setter method for the Attribute.
+    #
+    # Returns the name of the attribute as a Symbol with an appended '='.
     def setter_method_name
       "#{name}=".to_sym
     end
 
+
+    # Public: Expose a getter and setter method for the Attribute
+    # on the passed in Controller class.
+    #
+    # klass - The Controller class where the Attribute getter and setter
+    # methods will be exposed.
     def expose!(klass)
       attribute = self
 

data/lib/adequate_exposure/behavior.rb

@@ -1,10 +1,20 @@
 module AdequateExposure
   module Behavior
+    # Public: Fetches a scope.
+    #
+    # Finds an object. If it isn't found, the object gets instantiated.
+    #
+    # Returns the decorated object.
     def fetch
       instance = id ? find(id, computed_scope) : build(build_params, computed_scope)
       decorate(instance)
     end
 
+    # Public: Checks a params hash for an id attribute.
+    #
+    # Checks a hash of parameters for keys that represent an object's id.
+    #
+    # Returns the value of the id parameter, if it exists. Otherwise nil.
     def id
       params_id_key_candidates.each do |key|
         value = params[key]
@@ -14,26 +24,57 @@ module AdequateExposure
       nil
     end
 
+    # Public: An object query. Essentially, this method is designed to be
+    # overridden.
+    #
+    # model - The Class to be scoped or queried.
+    #
+    # Returns the object scope.
     def scope(model)
       model
     end
 
+    # Public: Converts a name into a standard Class name.
+    #
+    # Examples
+    #   'egg_and_hams'.model # => EggAndHam
+    #
+    # Returns a standard Class name.
     def model
       name.to_s.classify.constantize
     end
 
+    # Public: Find an object on the supplied scope.
+    #
+    # id    - The Integer id attribute of the desired object
+    # scope - The collection that will be searched.
+    #
+    # Returns the found object.
     def find(id, scope)
       scope.find(id)
     end
 
+    # Public: Builds a new object on the passed-in scope.
+    #
+    # params - A Hash of attributes for the object to-be built.
+    # scope  - The collection that will be searched.
+    #
+    # Returns the new object.
     def build(params, scope)
       scope.new(params)
     end
 
+    # Public: Returns a decorated object. This method is designed to be
+    # overridden.
+    #
+    # Returns the decorated object.
     def decorate(instance)
       instance
     end
 
+    # Public: Get all the parameters of the current request.
+    #
+    # Returns the controller's parameters for the current request.
     def build_params
       if controller.respond_to?(params_method_name, true) && !get_request?
         controller.send(params_method_name)
@@ -45,7 +86,7 @@ module AdequateExposure
     protected
 
     def params_id_key_candidates
-      [ "#{model.name.underscore}_id", "#{name}_id", "id" ].uniq
+      [ "#{model_param_key}_id", "#{name}_id", "id" ].uniq
     end
 
     def model_param_key

data/lib/adequate_exposure/context.rb

@@ -2,14 +2,33 @@ module AdequateExposure
   class Context
     attr_reader :context, :attribute
 
+    # Public: Initialize a context.
+    #
+    # context   - The Class where the attribute is defined.
+    # attribute - The attribute that will be accessed by a getter
+    #             and setter.
     def initialize(context, attribute)
       @context, @attribute = context, attribute
     end
 
+    # Public: Read an attribute on the context Class.
+    #
+    # Get an attribute's value. If the attribute's instance
+    # variable is not defined, it will create one,
+    # execute attribute#fetch, and assign the result
+    # to the instance variable.
+    #
+    # Returns the attribute's value.
     def get
       ivar_defined?? ivar_get : set(fetch_value)
     end
 
+    # Public: Write to an attribute on the context Class.
+    #
+    # value - The value that will be set to the attribute's
+    #         instance variable.
+    #
+    # Returns the attribute's value.
     def set(value)
       ivar_set(value)
     end

data/lib/adequate_exposure/controller.rb

@@ -8,15 +8,42 @@ module AdequateExposure
     end
 
     module ClassMethods
+      # Public: Exposes an attribute to a controller Class.
+      #
+      # *args - An Array of attributes for the new exposure. See
+      #         Exposure#initialize for attribute details.
+      # block - If supplied, the exposed attribute method executes
+      #         the Proc when accessed.
+      #
+      # Returns the helper methods that are now defined on the class
+      # where this method is included.
       def expose(*args, &block)
         Exposure.expose! self, *args, &block
       end
 
+      # Public: Exposes an attribute to a controller Class.
+      # The exposed methods are then set to a before_action
+      # callback.
+      #
+      # name  - The String name of the Exposure instance.
+      # *args - An Array of attributes for the new exposure. See
+      #         Exposure#initialize for attribute details.
+      # block - If supplied, the exposed attribute method executes
+      #         the Proc when accessed.
+      #
+      # Sets the exposed attribute to a before_action callback in the
+      # controller.
       def expose!(name, *args, &block)
         expose name, *args, &block
         before_action name
       end
 
+      # Public: Configures an Exposure instance for a controller Class.
+      #
+      # name    - The String name of the Exposure instance.
+      # options - The Hash of options to configure the Exposure instance.
+      #
+      # Returns the exposure configuration Hash.
       def exposure_config(name, options)
         store = self.exposure_configuration ||= {}
         self.exposure_configuration = store.merge(name => options)

data/lib/adequate_exposure/exposure.rb

@@ -2,10 +2,38 @@ module AdequateExposure
   class Exposure
     attr_reader :controller, :options
 
+    # Public: Initializes an Exposure and makes it accessible to a controller.
+    # For each Exposure, a getter and setter is defined.
+    # Those getters and setters are made available to
+    # the controller as helper methods.
+    #
+    # *args  - An Array of all parameters for the new Exposure. See
+    #          #initialize.
+    # block  - If supplied, the exposed attribute method executes
+    #          the Proc when called.
+    #
+    # Returns a collection of exposed helper methods.
     def self.expose!(*args, &block)
       new(*args, &block).expose!
     end
 
+    # Public: Initalize an Exposure with a hash of options.
+    #
+    # If a block is given, the Proc is assigned to value
+    # of options[name].
+    #
+    # The `asserts_*` section raise errors if the controller
+    # was initialized with an unacceptable options Hash.
+    #
+    # controller  - The Controller class where methods will be exposed.
+    # name        - The String name of the Exposure instance.
+    # fetch_block - Proc that will be executed if the exposed
+    #               attribute has no value (default: nil).
+    # options     - Hash of options for the Behavior of the exposed methods.
+    # block       - If supplied, the exposed attribute method executes
+    #               the Proc.
+    #
+    # Returns a normalized options Hash.
     def initialize(controller, name, fetch_block=nil, **options, &block)
       @controller = controller
       @options = options.with_indifferent_access.merge(name: name)
@@ -22,6 +50,11 @@ module AdequateExposure
       normalize_options
     end
 
+    # Public: Creates a getter and setter methods for the attribute.
+    # Those methods are made avaiable to the controller as
+    # helper methods.
+    #
+    # Returns a collection of exposed helper methods.
     def expose!
       expose_attribute!
       expose_helper_methods!

data/lib/adequate_exposure/flow.rb

@@ -2,12 +2,24 @@ module AdequateExposure
   class Flow
     attr_reader :controller, :options, :name
 
+    # Public: Initialize a Flow. This object responds to missing
+    # methods errors and attempts to delegate them to other objects.
+    #
+    # controller - The Controller class where the method was called.
+    # options    - The options Hash of the Exposure instance being called.
+    # name       - The String name of the Exposure instance.
     def initialize(controller, options)
       @controller = controller
       @options = options
       @name = options.fetch(:name)
     end
 
+    # Public: Attempts to re-delegate a method missing to the
+    # supplied block or the Behavior object.
+    #
+    # name  - The String name of the Exposure instance.
+    # *args - The arguments given for the missing method.
+    # block - The Proc invoked by the method.
     def method_missing(name, *args, &block)
       if respond_to_missing?(name)
         handle_flow_method(name, *args, &block)
@@ -16,6 +28,11 @@ module AdequateExposure
       end
     end
 
+    # Public: Checks if the Behavior class can handle the missing method.
+    #
+    # method_name     - The name of method that has been called.
+    # include_private - Prevents this method from catching calls to private
+    # method (default: false).
     def respond_to_missing?(method_name, include_private = false)
       Behavior.method_defined?(method_name) || super
     end

data/lib/adequate_exposure/version.rb

@@ -1,3 +1,3 @@
 module AdequateExposure
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/support/rails_app.rb

@@ -32,7 +32,7 @@ class BirdsController < ApplicationController
   expose :bird
 
   def show
-    render nothing: true
+    head :ok
   end
 end
 

metadata

@@ -1,43 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: adequate_exposure
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Pavel Pravosud
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-23 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
 description: 
 email:
 - pavel@pravosud.com
@@ -47,11 +59,16 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- Appraisals
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - adequate_exposure.gemspec
+- gemfiles/rails_4.0.gemfile
+- gemfiles/rails_4.1.gemfile
+- gemfiles/rails_4.2.gemfile
+- gemfiles/rails_5.0.gemfile
 - lib/adequate_exposure.rb
 - lib/adequate_exposure/attribute.rb
 - lib/adequate_exposure/behavior.rb
@@ -84,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.4
 signing_key: 
 specification_version: 4
 summary: Exposing things, adequately