weak_parameters 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31ad205c14c4aa3637527ae17246de22941fdad6
-  data.tar.gz: 8f3fc4e4a94706371fbb446f18fecc4a7bee540a
+  metadata.gz: 487fdb7064411169290876e998a0711514aa381f
+  data.tar.gz: 1ba63113f459198581df79d0f90437a9298945f0
 SHA512:
-  metadata.gz: be122aa99d692c94c16b6b43ec111b8689ae2f277216491ba4018436913e62e7070356ad68092be9e8a86cc1ded7f894124e6680965b1e2bb07b3461e32e64a2
-  data.tar.gz: 4d6c0afcf6111f8d2c28049735069009234bbb2b52155d4f064f93145b3603894ecf9019eafb61be71a6b5055a767c13a6cae0392d15fb9443c91b7f4104bff9
+  metadata.gz: 1b91ff714bddccc4b7e4f631c4497e28432358e81d0d5ad47c2b2f39fa293590f161523d38c771ee4477318db01b7be0b1e9dabcddaa588134530d086b0bde0a
+  data.tar.gz: fc851acd2965b9814cb8bf7b6916ce57906ce0b1afedfd64f8de08a05d86742e96ee3de0ef5d03ec3e3496305c67d8ce5e4c5105ebf3a61aeddac89f2ccd474f

data/.gitignore

@@ -7,7 +7,6 @@ Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
 lib/bundler/man
 log/*.log
 pkg

data/Gemfile

@@ -3,6 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 group :test do
+  gem "autodoc"
   gem "pry-rails"
   gem "rspec-rails"
 end

data/README.md

@@ -35,12 +35,7 @@ irb(main):005:0> app.post "/recipes", name: "alice", type: "bob"
 ```
 
 ## Tips
-WeakParameters.stats returns its definition of validations.
-This is useful for auto-generating API documents.
+WeakParameters.stats returns its validation metadata, and this is useful for auto-generating API documents.
+With [autodoc](https://github.com/r7kamura/autodoc), you can auto-generate API documents with params information.
 
-```ruby
-WeakParameters::stats[:recipes][:create].validators[0].key       #=> :name
-WeakParameters::stats[:recipes][:create].validators[0].required? #=> true
-WeakParameters::stats[:recipes][:create].validators[1].key       #=> :type
-WeakParameters::stats[:recipes][:create].validators[1].required? #=> false
-```
+https://github.com/r7kamura/autodoc

data/lib/weak_parameters/array_validator.rb

@@ -0,0 +1,13 @@
+module WeakParameters
+  class ArrayValidator < WeakParameters::BaseValidator
+    private
+
+    def valid_type?
+      value.is_a?(Array)
+    end
+
+    def error_message
+      "params[#{key.inspect}] must be an Array"
+    end
+  end
+end

data/lib/weak_parameters/base_validator.rb

@@ -9,7 +9,7 @@ module WeakParameters
     end
 
     def validate
-      raise_required_error if required? && nil?
+      raise_error if required? && nil? || exist? && invalid_type?
     end
 
     def required?
@@ -26,12 +26,28 @@ module WeakParameters
       value.nil?
     end
 
+    def exist?
+      !nil?
+    end
+
     def value
       params[key]
     end
 
-    def raise_required_error
-      raise WeakParameters::ValidationError, "params[#{key.inspect}] is required"
+    def raise_error
+      raise WeakParameters::ValidationError, error_message
+    end
+
+    def error_message
+      "params[#{key.inspect}] is required"
+    end
+
+    def valid_type?
+      true
+    end
+
+    def invalid_type?
+      !valid_type?
     end
   end
 end

data/lib/weak_parameters/boolean_validator.rb

@@ -0,0 +1,17 @@
+module WeakParameters
+  class BooleanValidator < WeakParameters::BaseValidator
+    def type
+      :boolean
+    end
+
+    private
+
+    def valid_type?
+      %w[0 1 false true].include?(value)
+    end
+
+    def error_message
+      "params[#{key.inspect}] must be 0, 1, false or true"
+    end
+  end
+end

data/lib/weak_parameters/hash_validator.rb

@@ -0,0 +1,13 @@
+module WeakParameters
+  class HashValidator < WeakParameters::BaseValidator
+    private
+
+    def valid_type?
+      value.is_a?(Hash)
+    end
+
+    def error_message
+      "params[#{key.inspect}] must be an Hash"
+    end
+  end
+end

data/lib/weak_parameters/integer_validator.rb

@@ -1,22 +1,11 @@
 module WeakParameters
   class IntegerValidator < WeakParameters::BaseValidator
-    def validate
-      super
-      raise_integer_error if !nil? && !integer?
-    end
-
-    def type
-      :integer
-    end
-
-    private
-
-    def integer?
+    def valid_type?
       /\A-?\d+\z/ === value
     end
 
-    def raise_integer_error
-      raise WeakParameters::ValidationError, "params[#{key.inspect}] must be an Integer"
+    def error_message
+      "params[#{key.inspect}] must be an Integer"
     end
   end
 end

data/lib/weak_parameters/string_validator.rb

@@ -0,0 +1,4 @@
+module WeakParameters
+  class StringValidator < WeakParameters::BaseValidator
+  end
+end

data/lib/weak_parameters/validator.rb

@@ -15,6 +15,10 @@ module WeakParameters
       @validators ||= []
     end
 
+    def type
+      self.class.name.split("::").last.sub(/Validator$/, "").underscore.to_sym
+    end
+
     private
 
     def string(key, options = {})
@@ -24,5 +28,17 @@ module WeakParameters
     def integer(key, options = {})
       validators << WeakParameters::IntegerValidator.new(params, key, options)
     end
+
+    def boolean(key, options = {})
+      validators << WeakParameters::BooleanValidator.new(params, key, options)
+    end
+
+    def hash(key, options = {})
+      validators << WeakParameters::HashValidator.new(params, key, options)
+    end
+
+    def array(key, options = {})
+      validators << WeakParameters::ArrayValidator.new(params, key, options)
+    end
   end
 end

data/lib/weak_parameters/version.rb

@@ -1,3 +1,3 @@
 module WeakParameters
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/weak_parameters.rb

@@ -2,8 +2,12 @@ require "action_controller"
 require "active_support/hash_with_indifferent_access"
 
 require "weak_parameters/base_validator"
-require "weak_parameters/controller"
+require "weak_parameters/array_validator"
+require "weak_parameters/boolean_validator"
+require "weak_parameters/hash_validator"
 require "weak_parameters/integer_validator"
+require "weak_parameters/string_validator"
+require "weak_parameters/controller"
 require "weak_parameters/validation_error"
 require "weak_parameters/validator"
 require "weak_parameters/version"

data/spec/dummy/app/controllers/recipes_controller.rb

@@ -2,13 +2,12 @@ class RecipesController < ApplicationController
   validates :create do
     string :name, required: true
     integer :type
-  end
-
-  def show
-    respond_with Recipe.find(params[:id])
+    boolean :flag
+    hash :config
+    array :tags
   end
 
   def create
-    respond_with Recipe.create(params.slice(:name, :type))
+    head 201
   end
 end

data/spec/dummy/config/routes.rb

@@ -1,3 +1,3 @@
 Dummy::Application.routes.draw do
-  resources :recipes, only: [:show, :create]
+  resources :recipes, only: :create
 end

data/spec/requests/recipes_spec.rb

@@ -1,14 +1,13 @@
 require "spec_helper"
 
 describe "Recipes" do
-  let(:env) do
-    { "HTTP_ACCEPT" => "application/json" }
-  end
-
   let(:params) do
     {
       name: "name",
       type: 1,
+      flag: true,
+      config: {},
+      tags: [],
     }
   end
 
@@ -19,18 +18,51 @@ describe "Recipes" do
       end
 
       it "returns 400" do
-        post "/recipes", params, env
+        post "/recipes", params
         response.status.should == 400
       end
     end
 
-    context "with other typed param" do
+    context "with wrong integer param" do
       before do
         params[:type] = "x"
       end
 
       it "returns 400" do
-        post "/recipes", params, env
+        post "/recipes", params
+        response.status.should == 400
+      end
+    end
+
+    context "with wrong boolean param" do
+      before do
+        params[:flag] = "x"
+      end
+
+      it "returns 400" do
+        post "/recipes", params
+        response.status.should == 400
+      end
+    end
+
+    context "with wrong array param" do
+      before do
+        params[:tags] = "x"
+      end
+
+      it "returns 400" do
+        post "/recipes", params
+        response.status.should == 400
+      end
+    end
+
+    context "with wrong hash param" do
+      before do
+        params[:config] = "x"
+      end
+
+      it "returns 400" do
+        post "/recipes", params
         response.status.should == 400
       end
     end
@@ -41,14 +73,14 @@ describe "Recipes" do
       end
 
       it "creates a new recipe" do
-        post "/recipes", params, env
+        post "/recipes", params
         response.status.should == 201
       end
     end
 
-    context "with valid condition" do
+    context "with valid condition", :autodoc do
       it "creates a new recipe" do
-        post "/recipes", params, env
+        post "/recipes", params
         response.status.should == 201
       end
     end

data/spec/spec_helper.rb

@@ -13,4 +13,6 @@ RSpec.configure do |config|
   # automatically. This will be the default behavior in future versions of
   # rspec-rails.
   config.infer_base_class_for_anonymous_controllers = false
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weak_parameters
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ryo Nakamura
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-06-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -79,13 +79,16 @@ files:
 - README.md
 - Rakefile
 - lib/weak_parameters.rb
+- lib/weak_parameters/array_validator.rb
 - lib/weak_parameters/base_validator.rb
+- lib/weak_parameters/boolean_validator.rb
 - lib/weak_parameters/controller.rb
+- lib/weak_parameters/hash_validator.rb
 - lib/weak_parameters/integer_validator.rb
+- lib/weak_parameters/string_validator.rb
 - lib/weak_parameters/validation_error.rb
 - lib/weak_parameters/validator.rb
 - lib/weak_parameters/version.rb
-- spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -144,12 +147,11 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.2
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Add a validation filter to your controller.
 test_files:
-- spec/dummy/README.rdoc
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/application.js
 - spec/dummy/app/assets/stylesheets/application.css
@@ -187,3 +189,4 @@ test_files:
 - spec/dummy/script/rails
 - spec/requests/recipes_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/spec/dummy/README.rdoc

@@ -1,261 +0,0 @@
-== Welcome to Rails
-
-Rails is a web-application framework that includes everything needed to create
-database-backed web applications according to the Model-View-Control pattern.
-
-This pattern splits the view (also called the presentation) into "dumb"
-templates that are primarily responsible for inserting pre-built data in between
-HTML tags. The model contains the "smart" domain objects (such as Account,
-Product, Person, Post) that holds all the business logic and knows how to
-persist themselves to a database. The controller handles the incoming requests
-(such as Save New Account, Update Product, Show Post) by manipulating the model
-and directing data to the view.
-
-In Rails, the model is handled by what's called an object-relational mapping
-layer entitled Active Record. This layer allows you to present the data from
-database rows as objects and embellish these data objects with business logic
-methods. You can read more about Active Record in
-link:files/vendor/rails/activerecord/README.html.
-
-The controller and view are handled by the Action Pack, which handles both
-layers by its two parts: Action View and Action Controller. These two layers
-are bundled in a single package due to their heavy interdependence. This is
-unlike the relationship between the Active Record and Action Pack that is much
-more separate. Each of these packages can be used independently outside of
-Rails. You can read more about Action Pack in
-link:files/vendor/rails/actionpack/README.html.
-
-
-== Getting Started
-
-1. At the command prompt, create a new Rails application:
-       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
-
-2. Change directory to <tt>myapp</tt> and start the web server:
-       <tt>cd myapp; rails server</tt> (run with --help for options)
-
-3. Go to http://localhost:3000/ and you'll see:
-       "Welcome aboard: You're riding Ruby on Rails!"
-
-4. Follow the guidelines to start developing your application. You can find
-the following resources handy:
-
-* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
-* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
-
-
-== Debugging Rails
-
-Sometimes your application goes wrong. Fortunately there are a lot of tools that
-will help you debug it and get it back on the rails.
-
-First area to check is the application log files. Have "tail -f" commands
-running on the server.log and development.log. Rails will automatically display
-debugging and runtime information to these files. Debugging info will also be
-shown in the browser on requests from 127.0.0.1.
-
-You can also log your own messages directly into the log file from your code
-using the Ruby logger class from inside your controllers. Example:
-
-  class WeblogController < ActionController::Base
-    def destroy
-      @weblog = Weblog.find(params[:id])
-      @weblog.destroy
-      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
-    end
-  end
-
-The result will be a message in your log file along the lines of:
-
-  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
-
-More information on how to use the logger is at http://www.ruby-doc.org/core/
-
-Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
-several books available online as well:
-
-* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
-* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
-
-These two books will bring you up to speed on the Ruby language and also on
-programming in general.
-
-
-== Debugger
-
-Debugger support is available through the debugger command when you start your
-Mongrel or WEBrick server with --debugger. This means that you can break out of
-execution at any point in the code, investigate and change the model, and then,
-resume execution! You need to install ruby-debug to run the server in debugging
-mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
-
-  class WeblogController < ActionController::Base
-    def index
-      @posts = Post.all
-      debugger
-    end
-  end
-
-So the controller will accept the action, run the first line, then present you
-with a IRB prompt in the server window. Here you can do things like:
-
-  >> @posts.inspect
-  => "[#<Post:0x14a6be8
-          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
-       #<Post:0x14a6620
-          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
-  >> @posts.first.title = "hello from a debugger"
-  => "hello from a debugger"
-
-...and even better, you can examine how your runtime objects actually work:
-
-  >> f = @posts.first
-  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
-  >> f.
-  Display all 152 possibilities? (y or n)
-
-Finally, when you're ready to resume execution, you can enter "cont".
-
-
-== Console
-
-The console is a Ruby shell, which allows you to interact with your
-application's domain model. Here you'll have all parts of the application
-configured, just like it is when the application is running. You can inspect
-domain models, change values, and save to the database. Starting the script
-without arguments will launch it in the development environment.
-
-To start the console, run <tt>rails console</tt> from the application
-directory.
-
-Options:
-
-* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
-  made to the database.
-* Passing an environment name as an argument will load the corresponding
-  environment. Example: <tt>rails console production</tt>.
-
-To reload your controllers and models after launching the console run
-<tt>reload!</tt>
-
-More information about irb can be found at:
-link:http://www.rubycentral.org/pickaxe/irb.html
-
-
-== dbconsole
-
-You can go to the command line of your database directly through <tt>rails
-dbconsole</tt>. You would be connected to the database with the credentials
-defined in database.yml. Starting the script without arguments will connect you
-to the development database. Passing an argument will connect you to a different
-database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
-PostgreSQL and SQLite 3.
-
-== Description of Contents
-
-The default directory structure of a generated Ruby on Rails application:
-
-  |-- app
-  |   |-- assets
-  |   |   |-- images
-  |   |   |-- javascripts
-  |   |   `-- stylesheets
-  |   |-- controllers
-  |   |-- helpers
-  |   |-- mailers
-  |   |-- models
-  |   `-- views
-  |       `-- layouts
-  |-- config
-  |   |-- environments
-  |   |-- initializers
-  |   `-- locales
-  |-- db
-  |-- doc
-  |-- lib
-  |   |-- assets
-  |   `-- tasks
-  |-- log
-  |-- public
-  |-- script
-  |-- test
-  |   |-- fixtures
-  |   |-- functional
-  |   |-- integration
-  |   |-- performance
-  |   `-- unit
-  |-- tmp
-  |   `-- cache
-  |       `-- assets
-  `-- vendor
-      |-- assets
-      |   |-- javascripts
-      |   `-- stylesheets
-      `-- plugins
-
-app
-  Holds all the code that's specific to this particular application.
-
-app/assets
-  Contains subdirectories for images, stylesheets, and JavaScript files.
-
-app/controllers
-  Holds controllers that should be named like weblogs_controller.rb for
-  automated URL mapping. All controllers should descend from
-  ApplicationController which itself descends from ActionController::Base.
-
-app/models
-  Holds models that should be named like post.rb. Models descend from
-  ActiveRecord::Base by default.
-
-app/views
-  Holds the template files for the view that should be named like
-  weblogs/index.html.erb for the WeblogsController#index action. All views use
-  eRuby syntax by default.
-
-app/views/layouts
-  Holds the template files for layouts to be used with views. This models the
-  common header/footer method of wrapping views. In your views, define a layout
-  using the <tt>layout :default</tt> and create a file named default.html.erb.
-  Inside default.html.erb, call <% yield %> to render the view using this
-  layout.
-
-app/helpers
-  Holds view helpers that should be named like weblogs_helper.rb. These are
-  generated for you automatically when using generators for controllers.
-  Helpers can be used to wrap functionality for your views into methods.
-
-config
-  Configuration files for the Rails environment, the routing map, the database,
-  and other dependencies.
-
-db
-  Contains the database schema in schema.rb. db/migrate contains all the
-  sequence of Migrations for your schema.
-
-doc
-  This directory is where your application documentation will be stored when
-  generated using <tt>rake doc:app</tt>
-
-lib
-  Application specific libraries. Basically, any kind of custom code that
-  doesn't belong under controllers, models, or helpers. This directory is in
-  the load path.
-
-public
-  The directory available for the web server. Also contains the dispatchers and the
-  default HTML files. This should be set as the DOCUMENT_ROOT of your web
-  server.
-
-script
-  Helper scripts for automation and generation.
-
-test
-  Unit and functional tests along with fixtures. When using the rails generate
-  command, template test files will be generated for you and placed in this
-  directory.
-
-vendor
-  External libraries that the application depends on. Also includes the plugins
-  subdirectory. If the app has frozen rails, those gems also go here, under
-  vendor/rails/. This directory is in the load path.