clean_params 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YTJlOTkyYzZkYzhhMjU3NzY1N2I2NWJhYTg0MTUxOWM3ZjczNmY2Nw==
+    NzAwZjBlZjkwYzQ0NWE3NDIwZWU4NzUyODlkNjE0ZDZjZDM2NzJlNw==
   data.tar.gz: !binary |-
-    ZDNjOWM5NTI5ZTE1NGMyMzIwMWFjZWI4Y2U1M2UxYzQyMDIyMGE0NQ==
+    MzlhNTkzNDYyZTcyOTBhMzI0ZmYxNzAwODA3ZDIzNjhkYTNlZjliOQ==
 SHA512:
   metadata.gz: !binary |-
-    MmVkMTllZWQ2ZjY4NTExZDhhODRlZDZhMzEzZDIxYmIwNDAxMTkyZDMxNzRk
-    ZGNmOGRkZTRjNGE2MTFhZDk5YmJlNmEzNDU1MWNiZDIwNmI5ODczOGIyNDE5
-    Yzc1YWExMDg2OWFjYWE5N2IyOGY1MzcxZGM3NWFkMDY3ZDBhZTc=
+    YmE0OGY4OWUzYmI2OTU0OTZhMjUzYjJlYmUxZTNhN2MzNjZiMjdhOTY0ZGEw
+    YTZlNDFlM2NjNTU5MjliODYxOTU5MmE5NDBkNThhYmEzMTE5NDE1NDU4M2Fl
+    ZTVkMWFjYzcxMWEyMGVjZDRhY2VjZGNjMDdjNTNjZDc0YTczZTA=
   data.tar.gz: !binary |-
-    ZmM3YzMxY2QyYjE4ZjAzNDU1YTI5YzYzZDlmNDUxNjg2MjM4OTIzNDhmOTIz
-    YmUyYzAzM2ZiMTJmNjkxZDI2NTBmMTU5M2QzZTNlZWEyYjhjNDgxMjFmMGM4
-    NDlkZWViZTA3ZDVkMmFkY2IzMGQ1ODQ2MzE4NTdjY2M5MDc0MTg=
+    YWMzZGQxYjA1OTMyYzJmOTk5NWVhY2RkNDIwZDcyYmQ4MmQyYzZjODA2MTJh
+    NGI0MTA2MTk3ZjlhNTQ4NWUzNzhmYjRhM2M2ZTdjN2JhOTZkODQxOGVlZmUz
+    NTIyMGQ1NTgzZWEyYTEwZTYxMjIxNDMxY2VmZTEzNjY4ZGVmMDg=

data/.rspec

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

data/README.md

@@ -1,7 +1,9 @@
 # CleanParams
 
 Clean Params is a Ruby gem for use with Rails to access the controller parameters cleanly.
-No more ugly hash accesses. No more case sensitive checking.
+No more ugly hash accesses. No more flooding your codebase with multiple condition checking.
+With clean_params you can specify various rules to parse your params hash inside the initializer file.
+It also allows for nested hash parsing.
 
 ## Installation
 
@@ -18,6 +20,8 @@ Run the generator to create the initializer file. You can specify your parsing r
 	params = CleanParams.clean(params) # params - rails params hash
 	params.key # => params[:key]
 	params.token # => params[:token]
+	
+Or you can include it inside the filter in ApplicationController and use the object inside any controller.
 
 ## Contributing
 

data/clean_params.gemspec

@@ -20,4 +20,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 end

data/lib/clean_params.rb

@@ -1,31 +1,42 @@
 require "clean_params/version"
-require 'active_support/core_ext/hash'
+#require 'active_support/core_ext/hash'
 
 module CleanParams
   class << self
     attr_accessor :configuration
   end
 
+  # Sets configuration object
   def self.configure
     self.configuration ||= Configuration.new
     yield(configuration)
   end
   
+  # main method call; returns the final object
   def self.clean(controllerParams)
-    configuration.extract_params(controllerParams.with_indifferent_access)
+    configuration.controller_params = controllerParams
+    configuration.extract_params
     return configuration
   end
 
   class Configuration
-    attr_accessor :params
+    attr_accessor :params, :controller_params
     
-    def extract_params(controllerParams)
+    # for each rule in configuration file, check the params hash and sets instance variables
+    def extract_params
       params.each do |key, val|
-        self.class.send(:attr_accessor, key)
-        instance_variable_set("@#{key}", get_value_from_params(val, controllerParams))
+        set_instances(key, val)
       end
     end
     
+    private
+    
+    def set_instances(key, val)
+      self.class.send(:attr_accessor, key)
+      instance_variable_set("@#{key}", get_value_from_params(val, controller_params))
+    end
+    
+    # search params hash for values in rules
     def get_value_from_params(val, controllerParams)
       if val.is_a? String
         val = val.split(",")
@@ -37,15 +48,19 @@ module CleanParams
       nil # return nil if no match
     end
     
+    # Utility method: search hash recursively
     def search_hash(h, search)
       return h[search] if h.fetch(search, nil)
-
       h.keys.each do |k|
         answer = search_hash(h[k], search) if h[k].is_a? Hash
         return answer if answer
       end
-
       nil
     end
+    
+    # return nil if no rule for this attribute
+    def method_missing(method, *args, &block)
+      set_instances(method, method.to_s)
+    end
   end
 end

data/lib/clean_params/version.rb

@@ -1,3 +1,3 @@
 module CleanParams
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/spec/clean_params_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe CleanParams do
+  before(:each) do
+    CleanParams.configure do |config|
+      config.params = {
+        'key' => ['key', 'Key'],
+        'token' => ['token', "Token"],
+        'source' => ['source', 'Source'],
+        'name' => ['name', 'Name', 'customer_name']
+      }
+    end
+  end
+  
+  let(:hash) { {"key"=>"123", "Key" => "345", "keys" => "1,2,3", "token"=>"asd34dd", "nested"=>{"source"=>"clean_params", "name"=>"XYZ"}} }
+  let(:res) { CleanParams.clean(hash) }
+  
+  it "should return the match correctly" do
+    expect(res.token).to be == 'asd34dd'
+  end
+
+  it "should return the first match" do
+    expect(res.key).to be == '123'
+  end
+  
+  it "should return the nested param correctly" do
+    expect(res.source).to be == 'clean_params'
+  end
+  
+  it "should return nil for the no-match" do
+    expect(res.sources).to be_nil
+  end
+  
+  it "should return value if present for no rule" do
+    expect(res.keys).to be == "1,2,3"
+  end
+  
+  it "should return nil if not present for no rule" do
+    expect(res.no_keys).to be_nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+Bundler.require(:default)
+
+RSpec.configure do |config|
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clean_params
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Yogesh Pendharkar
@@ -38,6 +38,20 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Easy and clean way to maintain your params.
 email:
 - yogesh.pendharkar@gmail.com
@@ -46,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -55,6 +70,8 @@ files:
 - lib/clean_params/version.rb
 - lib/generators/clean_params/install_generator.rb
 - lib/generators/clean_params/templates/clean_params.rb
+- spec/clean_params_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/ypendharkar/clean_params
 licenses:
 - MIT
@@ -79,4 +96,6 @@ rubygems_version: 2.1.3
 signing_key: 
 specification_version: 4
 summary: Clean your params hash with clean_params
-test_files: []
+test_files:
+- spec/clean_params_spec.rb
+- spec/spec_helper.rb