simple_params 0.0.2.pre7 → 0.0.2.pre8

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NGJkNjAzNzZhMWU3YmZjOGVhMGVlNjAxM2QyZjkwZDM2NjdiMDAxZA==
+    YjQ1MzU1MGIxNmU3ZTA4MGZhZGY5YTg4YjZmZTY0ZjI1NmE3MTU0OQ==
   data.tar.gz: !binary |-
-    YTVlYWJiMmI1NjlmNWNlZjc4ZDdkZjIwNDY5NjFjNmNhODgxZDExZg==
+    ZmRiNWQ0ZjEwYjVmOWEzM2IzNGVhNTc1NTM1ODRjN2VlNDMwYTMwMA==
 SHA512:
   metadata.gz: !binary |-
-    YmRiYTg4NDRiOGY0NmFjMjg1YmQ2ZTI1M2UzOTA4NDUxNmUwZjdiODNhY2Q1
-    OTE4Mjk4OGY4ZmVlZTQ5ZTRmZTdiOTEzN2I0YjBlMDljMzIwMGVkZGM0Nzlm
-    MmMxYzBkN2NmNzMwMzc3ZGE0MjdmZDFmM2JjMTFhNzUwNjNhMzc=
+    YmU0MzFlNTYwNDdkYTY2Y2YyOGFhYmJiZWJmZmQ1OTUyYWVjNDE5MjA2OWRl
+    ZmQzZjhlMDcxZTYxYzgxYzdkZjQwNzY0ZTJkNmIwNDE5NDdjMTRmYjYyMjMx
+    M2Y2NDJmZTIzYzczNDY2OTFkMzNjZjZjMmM2MzA3Yjk2MGNlOWI=
   data.tar.gz: !binary |-
-    YmMxZGY0NjgwNDIwOWZiMTY0NGFmYTNmOWYxZTU1NjhiMGU4N2RkNWJmYWY1
-    YTY4YjFlMzM4ZjAyMDcxYmIyODk5MzJmMzVjMzAyNmE4OWJkOTU4Mjk3Y2Iz
-    MWZiMDUzYzIzMGQxMGNlZTYzM2Q0NmU5NjEwYTAwZTg1ZWNiYjU=
+    ZTg5MWUxNGFjY2VlMWNhMWNjN2EyNjRiZWI2MTEzMDgyOGIwODNjYTViNjI5
+    MzRjODdhNTYwMTc4ZThiY2Q4NmY3Njk3NWI5NDYwNjg4MmZlMmUyYzI2ODAw
+    ZjNjZWQ4NzQwZmIyZTlmYjEyOTJiNWQ1YjRiNjEzNzU2ODI4YTI=

data/.rspec

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

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_params (0.0.2.pre6)
+    simple_params (0.0.2.pre7)
       activemodel (>= 3.0, < 5.0)
       virtus (>= 1.0.0)
 

data/lib/simple_params/api_pie_doc/attribute.rb

@@ -1,52 +1,27 @@
 module SimpleParams
-  class ApiPieDoc::Attribute
-    attr_accessor :attribute, :nested, :options
-
-    alias :nested? :nested
+  class ApiPieDoc::Attribute < ApiPieDoc::AttributeBase
 
     def initialize(simple_params_attribute)
-      self.attribute = simple_params_attribute
-      self.nested = simple_params_attribute.is_a?(Hash)
-      self.options ||= nested? ? attribute.delete(:options) : attribute[1]
+      super
+      self.options ||= attribute[1]
     end
 
     def name
-      nested? ? attribute.keys.first.to_s : attribute[0].to_s
+      attribute[0].to_s
     end
 
     def to_s
       return nil if do_not_document?
-
-      if nested?
-        nested_description
-      else
-        attribute_description
-      end
+      attribute_description
     end
 
     private
 
-    def do_not_document?
-      options[:document].eql?(false)
-    end
-
-    def nested_description
-      start = "param :#{name}, Hash, #{description}, #{requirement_description} do"
-      attribute_descriptors = []
-      attribute.values.flat_map(&:to_a).each do |nested_attribute|
-        attribute_descriptors << self.class.new(nested_attribute).to_s
-      end
-      finish = "end"
-      [start, attribute_descriptors, finish].flatten.join("\n")
-    end
-
     def attribute_description
       base = "param :#{name}"
       [base, type_description, description, requirement_description].reject(&:blank?).join(", ")
     end
 
-    NotValidValueError = Class.new(StandardError)
-
     def type_description
       value = options[:type]
       case value
@@ -60,22 +35,5 @@ module SimpleParams
         raise NotValidValueError.new("Must be one of #{SimpleParams::Params::TYPES}")
       end
     end
-
-    def requirement_description
-      value = options[:optional]
-      case value
-      when true
-        ""
-      when false
-        "required: true"
-      else
-        "required: true"
-      end
-    end
-
-    def description
-      description = options[:desc] || ''
-      "desc: '#{description}'"
-    end
   end
 end

data/lib/simple_params/api_pie_doc/attribute_base.rb

@@ -0,0 +1,34 @@
+module SimpleParams
+  class ApiPieDoc::AttributeBase
+    attr_accessor :attribute, :options
+
+    def initialize(simple_params_attribute)
+      self.attribute = simple_params_attribute
+    end
+
+    private
+
+    def do_not_document?
+      options[:document].eql?(false)
+    end
+
+    NotValidValueError = Class.new(StandardError)
+
+    def requirement_description
+      value = options[:optional]
+      case value
+      when true
+        "required: false"
+      when false
+        "required: true"
+      else
+        "required: true"
+      end
+    end
+
+    def description
+      description = options[:desc] || ''
+      "desc: '#{description}'"
+    end
+  end
+end

data/lib/simple_params/api_pie_doc/nested_attribute.rb

@@ -0,0 +1,31 @@
+module SimpleParams
+  class ApiPieDoc::NestedAttribute < ApiPieDoc::AttributeBase
+
+    attr_accessor :attributes
+
+    def initialize(simple_params_attribute)
+      super
+      self.attributes = attribute.values[0].map { |attribute| ApiPieDoc::Attribute.new(attribute) }
+      self.options ||= attribute.delete(:options) || attribute[1]
+    end
+
+    def name
+      attribute.keys.first.to_s
+    end
+
+    def to_s
+      return nil if do_not_document?
+      nested_description
+    end
+
+    private
+
+    def nested_description
+      start = "param :#{name}, Hash, #{description}, #{requirement_description} do"
+      attribute_descriptors = []
+      attributes.each { |attribute| attribute_descriptors << attribute.to_s }
+      finish = "end"
+      [start, attribute_descriptors, finish].flatten.join("\n")
+    end
+  end
+end

data/lib/simple_params/api_pie_doc.rb

@@ -21,7 +21,7 @@ module SimpleParams
       end
 
       nested_attributes.each do |nested_attribute|
-        docs << Attribute.new(nested_attribute).to_s
+        docs << NestedAttribute.new(nested_attribute).to_s
       end
 
       docs.join("\n")

data/lib/simple_params/errors.rb

@@ -88,7 +88,7 @@ module SimpleParams
         self.messages.dup
       end
 
-      nested_messages = @nested_attributes.map do |attribute|
+      @nested_attributes.map do |attribute|
         errors = nested_error_messages(attribute, full_messages)
         unless errors.empty?
           messages.merge!(attribute.to_sym => errors)
@@ -97,13 +97,18 @@ module SimpleParams
       messages
     end
 
+    def to_s(full_messages = false)
+      array = to_a
+      array.join(', ')
+    end
+
     private
     def nested_error_messages(attribute, full_messages = false)
       if fetch_nested_attribute(attribute)
         if full_messages
           errors = fetch_nested_attribute(attribute).errors
-          errors.messages.each_with_object({}) do |(attribute, array), messages|
-            messages[attribute] = array.map { |message| errors.full_message(attribute, message) }
+          errors.messages.each_with_object({}) do |(attr, array), messages|
+            messages[attr] = array.map { |message| errors.full_message(attr, message) }
           end
         else
           fetch_nested_attribute(attribute).errors.messages.dup

data/lib/simple_params/params.rb

@@ -58,7 +58,7 @@ module SimpleParams
       alias_method :nested, :nested_hash
 
       def nested_hashes
-        @nested_hashes || {}
+        @nested_hashes ||= {}
       end
 
       def defined_attributes
@@ -190,13 +190,13 @@ module SimpleParams
     end
 
     def define_anonymous_class(hash)
-      klass = Class.new(Params).tap do |klass|
+      klass = Class.new(Params).tap do |k|
         name_function = Proc.new {
           def self.model_name
             ActiveModel::Name.new(self, nil, "temp")
           end
         }
-        klass.class_eval(&name_function)
+        k.class_eval(&name_function)
       end
       klass.allow_undefined_params
       klass.new(hash)

data/lib/simple_params/version.rb

@@ -1,3 +1,3 @@
 module SimpleParams
-  VERSION = "0.0.2.pre7"
+  VERSION = "0.0.2.pre8"
 end

data/lib/simple_params.rb

@@ -6,4 +6,6 @@ require 'simple_params/validations'
 require 'simple_params/params'
 require 'simple_params/simple_params_error'
 require 'simple_params/api_pie_doc'
+require 'simple_params/api_pie_doc/attribute_base'
 require 'simple_params/api_pie_doc/attribute'
+require 'simple_params/api_pie_doc/nested_attribute'

data/spec/acceptance_spec.rb

@@ -157,14 +157,14 @@ describe SimpleParams::Params do
     it "generates valida api_pie documentation" do
       documentation = AcceptanceParams.api_pie_documentation
       api_docs = <<-API_PIE_DOCS
-        param:reference, Object, desc:''
+        param:reference, Object, desc:'', required: false
         param :name, String, desc: '', required: true
-        param :age, Integer, desc: ''
+        param :age, Integer, desc: '', required: false
         param :color, String, desc: '', required: true
         param :address, Hash, desc: '', required: true do
           param :street, String, desc: '', required: true
           param :city, String, desc: '', required: true
-          param :zip_code, String, desc: ''
+          param :zip_code, String, desc: '', required: false
           param :state, String, desc: '', required: true
         end
       API_PIE_DOCS

data/spec/api_pie_doc/attribute_spec.rb

@@ -2,83 +2,35 @@ require 'spec_helper'
 
 describe SimpleParams::ApiPieDoc::Attribute do
   let(:simple_param_attribute) { [:name, {:type=>:string}] }
-  let(:nested_simple_param_attribute) {
-    {:address=>
-      {:street=>{:type=>:string},
-       :city=>{:validations=>{:length=>{:in=>4..40}, :presence=>true}, :type=>:string},
-       :zip_code=>{:optional=>true, :type=>:string},
-       :state=>{:default=>"North Carolina", :type=>:string}
-      },
-    :options=>{desc: 'i like pie'}
-    }
-  }
   let(:api_pie_doc_attribute) { described_class.new(simple_param_attribute) }
-  let(:nested_api_pie_doc_attribute) { described_class.new(nested_simple_param_attribute) }
 
-  describe '#initialize' do
+  it_behaves_like 'a base attribute'
 
+  describe '#initialize' do
     specify 'should give instance an attribute' do
       expect(api_pie_doc_attribute.attribute).to eq simple_param_attribute
     end
 
-    specify 'should set nested' do
-      expect(api_pie_doc_attribute.nested).to eq false
+    specify 'should give instance some options' do
+      expect(api_pie_doc_attribute.options).to eq({ type: :string })
     end
   end
 
   describe '#name' do
-    context 'when attribute is nested' do
-      specify 'should set respond with the right name' do
-        expect(nested_api_pie_doc_attribute.name).to eq 'address'
-      end
-    end
-
-    context 'when attribute is not nested' do
-      specify 'should set respond with the right name' do
-        expect(api_pie_doc_attribute.name).to eq 'name'
-      end
+    specify 'should set respond with the right name' do
+      expect(api_pie_doc_attribute.name).to eq 'name'
     end
   end
 
   describe '#options' do
-    context 'when attribute is nested' do
-      specify 'should return nested attribute options' do
-        expect(nested_api_pie_doc_attribute.options).to eq({desc: 'i like pie'})
-      end
-    end
-
-    context 'when attribute is not nested' do
-      specify 'should return the attributes options' do
-        expect(api_pie_doc_attribute.options).to eq({ type: :string })
-      end
-    end
-  end
-
-  describe '#nested?' do
-    context 'when attribute is nested' do
-      specify 'should return true' do
-        expect(nested_api_pie_doc_attribute.nested?).to eq true
-      end
-    end
-
-    context 'when attribute is not nested' do
-      specify 'should return false' do
-        expect(api_pie_doc_attribute.nested?).to eq false
-      end
+    specify 'should return the attributes options' do
+      expect(api_pie_doc_attribute.options).to eq({ type: :string })
     end
   end
 
   describe '#to_s' do
-    context 'when attribute is nested' do
-      specify 'should return properly formatted string' do
-        expect(nested_api_pie_doc_attribute.to_s).to eq("param :address, Hash, desc: 'i like pie', required: true do\nparam :street, String, desc: '', required: true\nparam :city, String, desc: '', required: true\nparam :zip_code, String, desc: ''\nparam :state, String, desc: '', required: true\nend")
-      end
-    end
-
-    context 'when attribute is not nested' do
-      specify 'should return properly formatted string' do
-        expect(api_pie_doc_attribute.to_s).to eq("param :name, String, desc: '', required: true")
-      end
+    specify 'should return properly formatted string' do
+      expect(api_pie_doc_attribute.to_s).to eq("param :name, String, desc: '', required: true")
     end
   end
 
@@ -103,43 +55,4 @@ describe SimpleParams::ApiPieDoc::Attribute do
       end
     end
   end
-
-  describe "#requirement_description" do
-    context "when attribute options[:optional] is true" do
-      specify "should return a formatted string indicating the attribute is not required" do
-        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:optional=>true}])
-        expect(attribute.send(:requirement_description)).to eq ""
-      end
-    end
-
-    context "when attribute options[:optional] is false" do
-      specify "should return a formatted string indicating the attribute is required" do
-        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:optional=>false}])
-        expect(attribute.send(:requirement_description)).to eq "required: true"
-      end
-    end
-
-    context "when passed anything other than true or false" do
-      specify "should return a formatted string indicating the attribute is required" do
-        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:optional=>:blah}])
-        expect(attribute.send(:requirement_description)).to eq "required: true"
-      end
-    end
-  end
-
-  describe "#description" do
-    context "when attribute options[:desc] is not nil" do
-      specify "should use options[:desc] to populate attribute description" do
-        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:desc => 'I like pie'}])
-        expect(attribute.send(:description)).to eq "desc: 'I like pie'"
-      end
-    end
-
-    context "when attribute options[:desc] is nil" do
-      specify "should return an empty string as the description" do
-        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {}])
-        expect(attribute.send(:description)).to eq "desc: ''"
-      end
-    end
-  end
 end

data/spec/api_pie_doc/nested_attribute_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe SimpleParams::ApiPieDoc::NestedAttribute do
+
+  let(:simple_param_attribute) {
+    {:address=>
+      {:street=>{:type=>:string},
+       :city=>{:validations=>{:length=>{:in=>4..40}, :presence=>true}, :type=>:string},
+       :zip_code=>{:optional=>true, :type=>:string},
+       :state=>{:default=>"North Carolina", :type=>:string}
+      },
+    :options=>{desc: 'i like pie'}
+    }
+  }
+  let(:nested_attribute) { described_class.new(simple_param_attribute) }
+
+  it_behaves_like 'a base attribute'
+
+  describe '#initialize' do
+    specify 'should give instance an attribute' do
+      expect(nested_attribute.attribute).to eq simple_param_attribute
+    end
+
+    specify 'should give instance options' do
+      expect(nested_attribute.options).to eq({ desc: 'i like pie' })
+    end
+  end
+
+  describe '#name' do
+    specify 'should set respond with the right name' do
+      expect(nested_attribute.name).to eq 'address'
+    end
+  end
+
+  describe '#options' do
+    specify 'should return nested attribute options' do
+      expect(nested_attribute.options).to eq({desc: 'i like pie'})
+    end
+  end
+
+  describe '#to_s' do
+    specify 'should return properly formatted string' do
+      expect(nested_attribute.to_s).to eq("param :address, Hash, desc: 'i like pie', required: true do\nparam :street, String, desc: '', required: true\nparam :city, String, desc: '', required: true\nparam :zip_code, String, desc: '', required: false\nparam :state, String, desc: '', required: true\nend")
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -276,6 +276,22 @@ describe SimpleParams::Errors do
     end
   end
 
+  describe "#to_s" do
+    it "to_a returns the list of errors with complete messages containing the attribute names" do
+      person = Person.new
+      person.errors.add(:name, "can not be blank")
+      person.errors.add(:name, "can not be nil")
+      person.errors.to_s.should eq("name can not be blank, name can not be nil")
+    end
+
+    it "handles nested attributes" do
+      person = Person.new
+      person.errors.add(:name, "can not be blank")
+      person.dog.errors.add(:breed, "can not be nil")
+      person.errors.to_s.should eq("name can not be blank, dog breed can not be nil")
+    end
+  end
+
   describe "#to_hash" do
     it "to_hash returns the error messages hash" do
       person = Person.new

data/spec/params_spec.rb

@@ -293,14 +293,14 @@ describe SimpleParams::Params do
       documentation = DummyParams.api_pie_documentation
       api_docs = <<-API_PIE_DOCS
                   param :name, String, desc: '', required: true
-                  param :age, Integer, desc: ''
+                  param :age, Integer, desc: '', required: false
                   param :first_initial, String, desc: '', required: true
-                  param :amount, desc: ''
+                  param :amount, desc: '', required: false
                   param :color, String, desc: '', required: true
                   param :address, Hash, desc: '', required: true do
                     param :street, String, desc: '', required: true
                     param :city, String, desc: '', required: true
-                    param :zip_code, String, desc: ''
+                    param :zip_code, String, desc: '', required: false
                     param :state, String, desc: '', required: true
                   end
                   param :phone, Hash, desc: '', required: true do

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'bundler/setup'
 require 'simple_params'
 require 'pry'
 
-Dir[("../spec/support/**/*.rb")].each {|f| require f}
+Dir[File.join('.', 'spec', 'support', '**', '*.rb')].each {|f| require f}
 
 I18n.config.enforce_available_locales = true
 

data/spec/support/shared_examples/base_attribute.rb

@@ -0,0 +1,19 @@
+shared_examples "a base attribute" do
+
+  let(:base_attribute) { described_class.new(simple_param_attribute) }
+
+  describe 'base_attribute' do
+    specify 'should respond to do_not_document' do
+      expect(base_attribute.respond_to?(:do_not_document?, true)).to be_truthy
+    end
+
+    specify 'should respond to description' do
+      expect(base_attribute.respond_to?(:requirement_description, true)).to be_truthy
+    end
+
+    specify 'should respond to description' do
+      expect(base_attribute.respond_to?(:description, true)).to be_truthy
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre7
+  version: 0.0.2.pre8
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-02 00:00:00.000000000 Z
+date: 2015-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -116,6 +116,8 @@ files:
 - lib/simple_params.rb
 - lib/simple_params/api_pie_doc.rb
 - lib/simple_params/api_pie_doc/attribute.rb
+- lib/simple_params/api_pie_doc/attribute_base.rb
+- lib/simple_params/api_pie_doc/nested_attribute.rb
 - lib/simple_params/attribute.rb
 - lib/simple_params/errors.rb
 - lib/simple_params/formatter.rb
@@ -126,6 +128,7 @@ files:
 - simple_params.gemspec
 - spec/acceptance_spec.rb
 - spec/api_pie_doc/attribute_spec.rb
+- spec/api_pie_doc/nested_attribute_spec.rb
 - spec/api_pie_doc_spec.rb
 - spec/attribute_spec.rb
 - spec/errors_spec.rb
@@ -133,6 +136,7 @@ files:
 - spec/formatter_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/base_attribute.rb
 homepage: https://github.com/brycesenz/simple_params
 licenses:
 - MIT
@@ -160,6 +164,7 @@ summary: A DSL for specifying params, including type coercion and validation
 test_files:
 - spec/acceptance_spec.rb
 - spec/api_pie_doc/attribute_spec.rb
+- spec/api_pie_doc/nested_attribute_spec.rb
 - spec/api_pie_doc_spec.rb
 - spec/attribute_spec.rb
 - spec/errors_spec.rb
@@ -167,3 +172,4 @@ test_files:
 - spec/formatter_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb
+- spec/support/shared_examples/base_attribute.rb