template_params_rails 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73a0070b22cf745aaedbf77b10e308e3c18a839b
-  data.tar.gz: acbd3ddb5d9e48a11931a20dcdc0e9343912ec4c
+  metadata.gz: 94a5d2a3fb35eee0dc473833b53b945700eabc40
+  data.tar.gz: 51e6ccaa7cc4b71a027ba8bdd0b8d415d7969a86
 SHA512:
-  metadata.gz: 9f8a0889f5c2a9501777a06dc4aa4f7c45e406c2c01234b5a110e9f9b83c1d4adc7807b5291ff4f649b3ea7b0d07f9eac30d917c57cbaf5dc7516825848a0e95
-  data.tar.gz: 6a0efcee4b5539d3c494ab3d11d9fbbbee73853ffe38032d866ec1236fd2baf43529e35401b7d669b0f3db8ff7be16c165ec0954cceda3defee66579bfd488e0
+  metadata.gz: df8838534ff186f57af4cbdb6917245f71be792196169b3b1c33129360dc1f80f6e545c2d5bbf9add7b4bfdf8053d3fadcfb566ee976b88bfee353f47c8ad593
+  data.tar.gz: 5b8bb677a53cb3c6702acc5217c7fb2d2846911e0d215abccccad5e6a02760c5d1f5e90edbc420d63c38ec4eda274fdb0abb2af7597d675364f93f0123463fa6

data/README.md

@@ -1,9 +1,9 @@
 # TemplateParamsRails
+Runtime type-check for template preconditions, including instance variables
+and local variables. Think of this as the method signature of a template.
+There should be at least one of these assertions in almost every template.
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/template_params_rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
+template_params_rails project integrates [template_params](https://github.com/jaredbeck/template_params) for rails.
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -22,17 +22,30 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+In template, you may want use template_param like this:
+
+```ruby
+
+# Assert `poll` is defined. If not, raises an `ArgumentError` (the "arguments"
+# of the template are invalid).
+template_param { poll } 
 
-## Development
+# Assert `@course` is defined. Meaningless because instance variables are
+# always defined.
+template_param { @course } 
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Assert `poll.is_a?(::Poll)`. If not, raises a `TypeError`.
+template_param(::Poll) { poll }
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+# Assert `@course.is_a?(::Course)`
+template_param(::Course) { @course }
 
+# Assert `@course` is either a `::Course` or `nil`
+template_param(::Course, allow_nil: true) { @course }
+```
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/template_params_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/opodartho/template_params_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/template_params_rails/version.rb

@@ -1,3 +1,3 @@
 module TemplateParamsRails
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/template_params_rails.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "template_params"
+  spec.add_runtime_dependency "template_params", "~> 0.1.0"
 
   spec.add_development_dependency "bundler", "~> 1.12"
   spec.add_development_dependency "rake", "~> 10.0"

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: template_params_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Zahidul Haque
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-07-22 00:00:00.000000000 Z
+date: 2016-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: template_params
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement