simple_params 0.0.2.pre4 → 0.0.2.pre5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    OTVhZDQxZjQzMzZiMWI2ODU1MTc2MWNkMDJlYWY2M2YxN2JlNzMxZQ==
+    ZTZkN2ZhYmUzN2JhN2UyMTFmZDA1ZmE5MThiNGJiOTg1ZGEzZGY3YQ==
   data.tar.gz: !binary |-
-    YTk1ZjhhZGUwMmIyMjFlNmU5NThkNTczMDNiNDA0MGJhMmY4Y2U5Ng==
+    OWFiODcyY2M2ODAwODA3MGFhMDY5ZTkwMDQxM2M3MWE4NDdiNzAwMw==
 SHA512:
   metadata.gz: !binary |-
-    ZDJhZDkzY2Q5OTFmZmY1NDNhMDlmNDQ1MDA1YThiNjcwZDBlZDhhNmIxODQ0
-    NWQzYzg4YzQxMjMwZTY2NWJlZDg1ZGQxMDhmNWU0YTExMmI0ZjBhZmQwMzFm
-    ZWE0M2JiY2IzNzY5MTZmYWMzYzllYmE2Y2Q5ZGU1ZDYyOTgyZmY=
+    N2UwMzExNTc0ZGIxMzA4MDYxYzdiZWM1YTgwMzUxMmQzYjc4OTkzOTBiOGEw
+    YTBlMWM3Nzk2MzVjNjYxYzQ3ZmZkMzdhYjk2Y2MwM2ZhZTU3YjhiNTk1Y2Ix
+    ZDc4NzU3MzdhOGYzZjZkNTUxMjdjODZhYTE4Yzk0ZGUxMTJhZDc=
   data.tar.gz: !binary |-
-    NjFhZmI0NTZhNWE0NjNhNGU0YmUxZWFjYmY2M2NhM2MzMDgxZGYzNGMxZTFj
-    ZDI0YzgwOWE3YjQxMjAwZTgxNjU0NTA3NDJhNmM3MzlkNzVkMDhmYmZiOWFl
-    ZjMwMzFmYmY3ZTc3ZWVhOTYwOGZlM2FlZGMyNDNhNjQxYmFlNmI=
+    YjM3MTNkY2UxYzU5YmE5OGQxYmNiNTI2MjUzZGI4ZGExYWQzZTA4NjM3MzFm
+    YjllOGU4ZWZiYWRiODQxY2E1NmE4NDExY2JjNGNhYzYzODhiNDUwMjhlMDRh
+    YTdhOWE1MTNkZmRlYTY4NDZmNWEyYjFhN2U3NTkzZTliNGY2OGI=

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    simple_params (0.0.2.pre3)
+    simple_params (0.0.2.pre4)
       activemodel (>= 3.0, < 5.0)
       virtus (>= 1.0.0)
 
@@ -22,6 +22,7 @@ GEM
       ice_nine (~> 0.11.0)
       thread_safe (~> 0.3, >= 0.3.1)
     builder (3.2.2)
+    coderay (1.1.0)
     coercible (1.0.0)
       descendants_tracker (~> 0.0.1)
     descendants_tracker (0.0.4)
@@ -31,7 +32,12 @@ GEM
     i18n (0.7.0)
     ice_nine (0.11.1)
     json (1.8.2)
+    method_source (0.8.2)
     minitest (5.5.1)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
     rake (10.4.2)
     rspec (2.99.0)
       rspec-core (~> 2.99.0)
@@ -41,7 +47,8 @@ GEM
     rspec-expectations (2.99.2)
       diff-lcs (>= 1.1.3, < 2.0)
     rspec-mocks (2.99.3)
-    thread_safe (0.3.4)
+    slop (3.6.0)
+    thread_safe (0.3.5)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
     virtus (1.0.4)
@@ -55,6 +62,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.5)
+  pry
   rake (~> 10.1)
   rspec (~> 2.6)
   simple_params!

data/lib/simple_params/api_pie_doc/attribute.rb

@@ -0,0 +1,81 @@
+module SimpleParams
+  class ApiPieDoc::Attribute
+    attr_accessor :attribute, :nested, :options
+
+    alias :nested? :nested
+
+    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]
+    end
+
+    def name
+      nested? ? attribute.keys.first.to_s : attribute[0].to_s
+    end
+
+    def to_s
+      return nil if do_not_document?
+
+      if nested?
+        nested_description
+      else
+        attribute_description
+      end
+    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
+      when :string, :integer, :array, :hash
+        "#{value.to_s.capitalize.constantize}"
+      when 'String', 'Integer', 'Array', 'Hash'
+        "#{value}"
+      when :decimal, :datetime, :date, :time, :float, :boolean
+        ""
+      else
+        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.rb

@@ -0,0 +1,38 @@
+module SimpleParams
+  class ApiPieDoc
+
+    attr_accessor :base_attributes,
+                  :nested_hashes,
+                  :nested_attributes,
+                  :docs
+
+    def initialize(simple_params)
+      self.base_attributes = simple_params.defined_attributes
+      self.nested_hashes = simple_params.nested_hashes
+      self.nested_attributes = []
+      self.docs = []
+
+      build_nested_attributes
+    end
+
+    def build
+      base_attributes.each do |attribute|
+        docs << Attribute.new(attribute).to_s
+      end
+
+      nested_attributes.each do |nested_attribute|
+        docs << Attribute.new(nested_attribute).to_s
+      end
+
+      docs.join("\n")
+    end
+
+    private
+
+    def build_nested_attributes
+      nested_hashes.each do |name, parameter_set|
+        nested_attributes << { name => parameter_set.defined_attributes, options: parameter_set.options }
+      end
+    end
+  end
+end

data/lib/simple_params/params.rb

@@ -7,19 +7,20 @@ module SimpleParams
     include ActiveModel::Validations
     include SimpleParams::Validations
 
+    TYPES = [
+      :integer,
+      :string,
+      :decimal,
+      :datetime,
+      :date,
+      :time,
+      :float,
+      :boolean,
+      :array,
+      :hash
+    ]
+
     class << self
-      TYPES = [
-        :integer,
-        :string,
-        :decimal,
-        :datetime,
-        :date,
-        :time,
-        :float,
-        :boolean,
-        :array,
-        :hash
-      ]
 
       TYPES.each do |sym|
         define_method("#{sym}_param") do |name, opts={}|
@@ -27,7 +28,11 @@ module SimpleParams
         end
       end
 
-      attr_accessor :strict_enforcement
+      attr_accessor :strict_enforcement, :options
+
+      def api_pie_documentation
+        SimpleParams::ApiPieDoc.new(self).build
+      end
 
       def strict
         @strict_enforcement = true
@@ -44,7 +49,7 @@ module SimpleParams
 
       def nested_hash(name, opts={}, &block)
         attr_accessor name
-        nested_class = define_nested_class(&block)
+        nested_class = define_nested_class(opts, &block)
         @nested_hashes ||= {}
         @nested_hashes[name.to_sym] = nested_class
       end
@@ -82,7 +87,7 @@ module SimpleParams
         validates name, validations unless validations.empty?
       end
 
-      def define_nested_class(&block)
+      def define_nested_class(options, &block)
         Class.new(Params).tap do |klass|
           name_function = Proc.new {
             def self.model_name
@@ -91,6 +96,7 @@ module SimpleParams
           }
           klass.class_eval(&name_function)
           klass.class_eval(&block)
+          klass.class_eval("self.options = options")
         end
       end
     end
@@ -151,7 +157,7 @@ module SimpleParams
     end
 
     def set_accessors(params={})
-      params.each do |attribute_name, value| 
+      params.each do |attribute_name, value|
         # Don't set accessors for nested classes
         unless value.is_a?(Hash)
           send("#{attribute_name}=", value)
@@ -187,4 +193,4 @@ module SimpleParams
       klass.new(hash)
     end
   end
-end
+end

data/lib/simple_params/version.rb

@@ -1,3 +1,3 @@
 module SimpleParams
-  VERSION = "0.0.2.pre4"
+  VERSION = "0.0.2.pre5"
 end

data/lib/simple_params.rb

@@ -5,3 +5,5 @@ require 'simple_params/errors'
 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'

data/simple_params.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"
   spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "pry"
 end

data/spec/acceptance_spec.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 class AcceptanceParams < SimpleParams::Params
   param :name
-  param :age, type: Integer, optional: true
+  param :age, type: :integer, optional: true
   param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}
 
   nested_hash :address do
@@ -23,7 +23,7 @@ describe SimpleParams::Params do
       params.name = "Tom"
       params.name.should eq("Tom")
     end
-    
+
     it "has getter and setter methods for optional param" do
       params.should respond_to(:age)
       params.name.should be_nil
@@ -38,7 +38,7 @@ describe SimpleParams::Params do
         params.address.street = "1 Main St."
         params.address.street.should eq("1 Main St.")
       end
-      
+
       it "has getter and setter methods for optional param" do
         params.address.should respond_to(:zip_code)
         params.address.zip_code.should be_nil
@@ -49,13 +49,13 @@ describe SimpleParams::Params do
   end
 
   describe "array syntax", array_syntax: true do
-    let(:params) do 
+    let(:params) do
       AcceptanceParams.new(
-        name: "Bill", 
-        age: 30, 
-        address: { 
-          city: "Greenville" 
-        } 
+        name: "Bill",
+        age: 30,
+        address: {
+          city: "Greenville"
+        }
       )
     end
 
@@ -136,4 +136,24 @@ describe SimpleParams::Params do
       end
     end
   end
-end
+
+  describe "api_pie_documentation", api_pie_documentation: true do
+    it "generates valida api_pie documentation" do
+      documentation = AcceptanceParams.api_pie_documentation
+      api_docs = <<-API_PIE_DOCS
+        param :name, String, desc: '', required: true
+        param :age, Integer, desc: ''
+        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 :state, String, desc: '', required: true
+        end
+      API_PIE_DOCS
+
+      expect(documentation).to be_a String
+      expect(documentation.gsub(/\s+/, "")).to eq api_docs.gsub(/\s+/, "")
+    end
+  end
+end

data/spec/api_pie_doc/attribute_spec.rb

@@ -0,0 +1,145 @@
+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
+
+    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
+    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
+    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
+    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
+    end
+  end
+
+  describe "#type_description" do
+    context "where attribute.options[:type] is a accepted symbol" do
+      specify "should return a formatted string with constantized version of symbol" do
+        expect(api_pie_doc_attribute.send(:type_description)).to eq "String"
+      end
+    end
+
+    context "where attribute.options[:type] is a accepted string" do
+      specify "should return a formatted string with constantized version of symbol" do
+        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:type=>'String'}])
+        expect(attribute.send(:type_description)).to eq "String"
+      end
+    end
+
+    context "where attribute.options[:type] is anything else" do
+      specify "should raise an error" do
+        attribute = SimpleParams::ApiPieDoc::Attribute.new([:name, {:type=>'Craziness'}])
+        expect{attribute.send(:type_description)}.to raise_error(SimpleParams::ApiPieDoc::Attribute::NotValidValueError)
+      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_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'fixtures/dummy_params'
+
+describe SimpleParams::ApiPieDoc do
+
+  let(:api_pie_doc) { SimpleParams::ApiPieDoc.new(DummyParams) }
+
+  describe "#initialize" do
+    specify "should give object base_attributes" do
+      expect(api_pie_doc.base_attributes).to include(name: { type: :string })
+      expect(api_pie_doc.base_attributes).to include(age: { optional: true, type: :integer })
+      expect(api_pie_doc.base_attributes.keys).to include(:amount, :color, :first_initial)
+    end
+
+    specify "should give object nested_hashes" do
+      expect(api_pie_doc.nested_hashes.keys).to eq [:address, :phone]
+    end
+
+    specify "should call #build_nested_attributes" do
+      expect_any_instance_of(SimpleParams::ApiPieDoc).to receive(:build_nested_attributes)
+      api_pie_doc
+    end
+
+    specify "should give object nested_attributes" do
+      expect(api_pie_doc.nested_attributes.flat_map(&:keys)).to include(:address, :phone)
+      expect(api_pie_doc.nested_attributes[0].values.flat_map(&:keys)).to eq [:street, :city, :zip_code, :state]
+      expect(api_pie_doc.nested_attributes[1].values.flat_map(&:keys)).to eq [:cell_phone, :phone_number, :area_code]
+    end
+
+    specify "should give object docs" do
+      expect(api_pie_doc.docs).to eq []
+    end
+  end
+
+  describe "#build" do
+    specify "should return a string of api_pie documentation params" do
+      expect(api_pie_doc.build).to be_a String
+    end
+  end
+end

data/spec/fixtures/dummy_params.rb

@@ -0,0 +1,32 @@
+class DummyParams < SimpleParams::Params
+  string_param :name
+  integer_param :age, optional: true
+  string_param :first_initial, default: lambda { |params, param| params.name[0] if params.name.present? }
+  decimal_param :amount, optional: true, default: 0.10, formatter: lambda { |params, param| param.round(2) }
+  param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}, formatter: :lower_case_colors
+
+  nested_hash :address do
+    string_param :street
+    string_param :city, validations: { length: { in: 4..40 } }
+    string_param :zip_code, optional: true, validations: { length: { in: 5..9 } }
+    param :state, default: "North Carolina", formatter: :transform_state_code
+
+    def transform_state_code(val)
+      val == "SC" ? "South Carolina" : val
+    end
+  end
+
+  nested_hash :phone do
+    boolean_param :cell_phone, default: true
+    string_param :phone_number, validations: { length: { in: 7..10 } }, formatter: lambda { |params, attribute| attribute.gsub(/\D/, "") }
+    string_param :area_code, default: lambda { |params, param|
+      if params.phone_number.present?
+        params.phone_number[0..2]
+      end
+    }
+  end
+
+  def lower_case_colors(val)
+    val.downcase
+  end
+end

data/spec/params_spec.rb

@@ -1,37 +1,5 @@
 require 'spec_helper'
-
-class DummyParams < SimpleParams::Params
-  string_param :name
-  integer_param :age, optional: true
-  string_param :first_initial, default: lambda { |params, param| params.name[0] if params.name.present? }
-  decimal_param :amount, optional: true, default: 0.10, formatter: lambda { |params, param| param.round(2) }
-  param :color, default: "red", validations: { inclusion: { in: ["red", "green"] }}, formatter: :lower_case_colors
-
-  nested_hash :address do
-    string_param :street
-    string_param :city, validations: { length: { in: 4..40 } }
-    string_param :zip_code, optional: true, validations: { length: { in: 5..9 } }
-    param :state, default: "North Carolina", formatter: :transform_state_code
-
-    def transform_state_code(val)
-      val == "SC" ? "South Carolina" : val
-    end
-  end
-
-  nested_hash :phone do
-    boolean_param :cell_phone, default: true
-    string_param :phone_number, validations: { length: { in: 7..10 } }, formatter: lambda { |params, attribute| attribute.gsub(/\D/, "") }
-    string_param :area_code, default: lambda { |params, param| 
-      if params.phone_number.present? 
-        params.phone_number[0..2] 
-      end
-    }
-  end
-
-  def lower_case_colors(val)
-    val.downcase
-  end
-end
+require 'fixtures/dummy_params'
 
 describe SimpleParams::Params do
   describe "strict parameter enforcement" do
@@ -76,7 +44,7 @@ describe SimpleParams::Params do
       params.name = "Tom"
       params.name.should eq("Tom")
     end
-    
+
     it "has getter and setter methods for optional param" do
       params.should respond_to(:age)
       params.name.should be_nil
@@ -91,7 +59,7 @@ describe SimpleParams::Params do
         params.address.street = "1 Main St."
         params.address.street.should eq("1 Main St.")
       end
-      
+
       it "has getter and setter methods for optional param" do
         params.address.should respond_to(:zip_code)
         params.address.zip_code.should be_nil
@@ -102,13 +70,13 @@ describe SimpleParams::Params do
   end
 
   describe "array syntax", array_syntax: true do
-    let(:params) do 
+    let(:params) do
       DummyParams.new(
-        name: "Bill", 
-        age: 30, 
-        address: { 
-          city: "Greenville" 
-        } 
+        name: "Bill",
+        age: 30,
+        address: {
+          city: "Greenville"
+        }
       )
     end
 
@@ -163,13 +131,13 @@ describe SimpleParams::Params do
     it "coerces nested attributes on initialization" do
       params = DummyParams.new(address: { zip_code: 90210 })
       params.address.zip_code.should eq("90210")
-    end      
+    end
 
     it "coerces nested attributes from setters" do
       params = DummyParams.new
       params.address.zip_code = 90210
       params.address.zip_code.should eq("90210")
-    end      
+    end
   end
 
   describe "defaults", defaults: true do
@@ -312,4 +280,31 @@ describe SimpleParams::Params do
       end
     end
   end
-end
+
+  describe "api_pie_documentation", api_pie_documentation: true do
+    it "generates valida api_pie documentation" do
+      documentation = DummyParams.api_pie_documentation
+      api_docs = <<-API_PIE_DOCS
+                  param :name, String, desc: '', required: true
+                  param :age, Integer, desc: ''
+                  param :first_initial, String, desc: '', required: true
+                  param :amount, desc: ''
+                  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 :state, String, desc: '', required: true
+                  end
+                  param :phone, Hash, desc: '', required: true do
+                    param :cell_phone, desc: '', required: true
+                    param :phone_number, String, desc: '', required: true
+                    param :area_code, String, desc: '', required: true
+                  end
+                API_PIE_DOCS
+
+      expect(documentation).to be_a String
+      expect(documentation.gsub(/\s+/, "")).to eq api_docs.gsub(/\s+/, "")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'rubygems'
 require 'bundler/setup'
 require 'simple_params'
+require 'pry'
 
 Dir[("../spec/support/**/*.rb")].each {|f| require f}
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2.pre4
+  version: 0.0.2.pre5
 platform: ruby
 authors:
 - brycesenz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-07 00:00:00.000000000 Z
+date: 2015-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -86,6 +86,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: Simple way to specify API params
 email:
 - bryce.senz@gmail.com
@@ -100,6 +114,8 @@ files:
 - Gemfile.lock
 - README.md
 - lib/simple_params.rb
+- lib/simple_params/api_pie_doc.rb
+- lib/simple_params/api_pie_doc/attribute.rb
 - lib/simple_params/attribute.rb
 - lib/simple_params/errors.rb
 - lib/simple_params/formatter.rb
@@ -109,8 +125,11 @@ files:
 - lib/simple_params/version.rb
 - simple_params.gemspec
 - spec/acceptance_spec.rb
+- spec/api_pie_doc/attribute_spec.rb
+- spec/api_pie_doc_spec.rb
 - spec/attribute_spec.rb
 - spec/errors_spec.rb
+- spec/fixtures/dummy_params.rb
 - spec/formatter_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb
@@ -140,8 +159,11 @@ specification_version: 4
 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_spec.rb
 - spec/attribute_spec.rb
 - spec/errors_spec.rb
+- spec/fixtures/dummy_params.rb
 - spec/formatter_spec.rb
 - spec/params_spec.rb
 - spec/spec_helper.rb