template_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c1774f101a9565ae51656039844c05925f80b46d
+  data.tar.gz: bb4459fed7f5bd7b606d7cf4249fd4b856d41e6d
+SHA512:
+  metadata.gz: ebc359d467d0252da1d434900eb4fd14dbf36a5537da07130ca42d555921ea93e71cd6f05ad9ab8e3e7ca049c84adf2219ff13499848f42f9aefc3ff7957981d
+  data.tar.gz: c77f65ca1a5c9eca6575d9c6578ea2bef4a7b0d1dddcdc7d19fc47da033a1dfff95fadf8961fe96a212d5e414e0b6ef69c34ebb6a5303d297ec217b36acd528c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in template_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Jared Beck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,68 @@
+# TemplateParams
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'template_params'
+```
+
+then run `bundle`.
+
+## Usage
+
+In rails, you may want a helper method like this:
+
+```ruby
+# app/helpers/application_helper.rb
+require "template_params"
+def template_param(*args, &block)
+  ::TemplateParams::Assertion.assert(*args, &block)
+end
+
+# Assert `poll` is defined. If not, raises an `ArgumentError` (the "arguments"
+# of the template are invalid).
+template_param { poll } 
+
+# Assert `@course` is defined. Meaningless because instance variables are
+# always defined.
+template_param { @course } 
+
+# Assert `poll.is_a?(::Poll)`. If not, raises a `TypeError`.
+template_param(::Poll) { poll }
+
+# Assert `@course.is_a?(::Course)`
+template_param(::Course) { @course }
+
+# Assert `@course` is either a `::Course` or `nil`
+template_param(::Course, allow_nil: true) { @course }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`bundle exec rspec` to run the tests. You can also run `bin/console` for an
+interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/[USERNAME]/template_assertions. This project is intended to
+be a safe, welcoming space for collaboration, and contributors are expected to
+adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "template_params"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/template_params/assertion.rb

@@ -0,0 +1,69 @@
+require "method_source"
+
+module TemplateParams
+  class Assertion
+
+    # @api public
+    def initialize(type, options)
+      @type = type
+      @options = options
+    end
+
+    # Convenience constructor.
+    # @api public
+    def self.assert(type = nil, options = {}, &block)
+      new(type, options).apply(&block)
+    end
+
+    # Apply the instantiated assertion to the given block.
+    # @api public
+    def apply(&block)
+      assert_type assert_defined(&block)
+    end
+
+    private
+
+    # @api private
+    def allow_nil
+      @options.fetch(:allow_nil, false)
+    end
+
+    # Calls (yields to) the given block, and asserts that it does not
+    # raise a NameError. Returns the return value of the block.
+    # @api private
+    def assert_defined(&block)
+      value = nil
+      begin
+        value = yield
+      rescue NameError => e
+        raise ArgumentError, udef_msg(e, block)
+      end
+      value
+    end
+
+    # Raises a `TypeError` if `value` is not of `@type`.
+    # @api private
+    def assert_type(value)
+      unless @type.nil? || value.is_a?(@type) || allow_nil && value.nil?
+        fail TypeError, format("Expected %s, got %s", @type, value.class)
+      end
+    end
+
+    # Given a `NameError` and the block, return a string like:
+    #
+    # Undefined template parameter:
+    # undefined local variable or method `banana' for ..:
+    # template_param(::Banana, allow_nil: true) { banana }
+    #
+    # `Proc#source` is provided by the `method_source` gem.
+    #
+    # @api private
+    def udef_msg(name_error, block)
+      msg = "Undefined template parameter: #{name_error}"
+      if block.respond_to?(:source)
+        msg << ": " + block.source.strip
+      end
+      msg
+    end
+  end
+end

data/lib/template_params/version.rb

@@ -0,0 +1,3 @@
+module TemplateParams
+  VERSION = "0.1.0"
+end

data/lib/template_params.rb

@@ -0,0 +1,5 @@
+require "template_params/version"
+require "template_params/assertion"
+
+module TemplateParams
+end

data/template_params.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'template_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "template_params"
+  spec.version       = TemplateParams::VERSION
+  spec.authors       = ["Jared Beck"]
+  spec.email         = ["jared@jaredbeck.com"]
+  spec.summary       = "Parameter assertions for your view templates"
+  spec.homepage      = "https://github.com/jaredbeck/template_params"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+  spec.add_runtime_dependency "method_source", "~> 0.8.2"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: template_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jared Beck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: 
+email:
+- jared@jaredbeck.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/template_params.rb
+- lib/template_params/assertion.rb
+- lib/template_params/version.rb
+- template_params.gemspec
+homepage: https://github.com/jaredbeck/template_params
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Parameter assertions for your view templates
+test_files: []