template_params 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1774f101a9565ae51656039844c05925f80b46d
-  data.tar.gz: bb4459fed7f5bd7b606d7cf4249fd4b856d41e6d
+  metadata.gz: 8b1cf802577dadb1e6b66d780aa233b362d7b98b
+  data.tar.gz: dd783b0cd18b60cf08aaf1422ace70b483790a2e
 SHA512:
-  metadata.gz: ebc359d467d0252da1d434900eb4fd14dbf36a5537da07130ca42d555921ea93e71cd6f05ad9ab8e3e7ca049c84adf2219ff13499848f42f9aefc3ff7957981d
-  data.tar.gz: c77f65ca1a5c9eca6575d9c6578ea2bef4a7b0d1dddcdc7d19fc47da033a1dfff95fadf8961fe96a212d5e414e0b6ef69c34ebb6a5303d297ec217b36acd528c
+  metadata.gz: 98592ae0903886adcdda4806cb46ebca78fd6dd103d32b34495bc696b0f8c151ef16f75e2c63a87de58a526666fe0f604223cc72a87af7cfb18d02ffe73b6c14
+  data.tar.gz: 1f8538a1ce7aa5f6fc9db3fe5fe20fad09ca624dc70ff696bc2bc8dacd99b2c7af116449523e34880a07fa61b0f3bb4f5ef72142083d7b4a4e910e86b712d069

data/.rubocop.yml

@@ -0,0 +1,107 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+# The number of lines in a method is not a useful metric compared to `AbcSize`.
+# It's common to have very long methods (> 50 lines) which are quite simple. For
+# example, a method that returns a long string with only a few interpolations.
+Metrics/MethodLength:
+  Enabled: false
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# Use the semantic style. If a block has side effects use `do`, and if it is
+# pure use `{}`. This style is too nuanced for a linter, so the cop is
+# disabled.
+Style/BlockDelimiters:
+  Enabled: false
+
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+# Used consistently, both leading and trailing styles are valid, but
+# Singlebrook happens to use the trailing style.
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Use double negation wherever it would otherwise be impractical to convert
+# a value to an actual boolean.
+Style/DoubleNegation:
+  Enabled: false
+
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# Use a postfix (aka. modifier) conditional operator for single lines unless
+# doing so would exceed 60 chars.
+Style/IfUnlessModifier:
+  MaxLineLength: 60
+
+# The decision about when to use a guard clause is too nuanced for a linter.
+Style/GuardClause:
+  Enabled: false
+
+# In a multiline method call, put the closing parenthesis on its own line.
+# The first argument may either be on the first line, or the second. Both of the
+# following are correct:
+#
+# ```
+# # A. correct
+# create(:user,
+#   client: foo,
+#   long_line: blah
+# )
+#
+# # B. also correct
+# create(
+#   :user,
+#   client: foo,
+#   long_line: blah
+# )
+#
+# # C. not preferred
+# user = create :user,
+#   client: foo,
+#   long_line: blah
+# ```
+#
+# Rubocop supports B, but not A. This project allows both, so this cop is
+# disabled.
+Style/MultilineMethodCallBraceLayout:
+  Enabled: false
+
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+# This is a new cop in rubocop 0.41, and I'm not sure if I want to adopt it yet.
+Style/NumericLiteralPrefix:
+  Enabled: false
+
+# Use `x > 0` because it is more specific than `x.positive?`.
+# However, `x.zero?` is acceptable because it is specific enough.
+Style/NumericPredicate:
+  Enabled: false
+
+# This is a new cop, and has a bug: https://github.com/bbatsov/rubocop/issues/3515
+# When that bug is fixed, we can try it again.
+Style/SafeNavigation:
+  Enabled: false
+
+# The decision between double quotes and single quotes is not something Leon
+# or I feel strongly about, but we might as well be consistent, especially if
+# rubocop is going to `--auto-correct` for us. Double quotes are slightly
+# easier to read and there is no difference in performance. -Jared 2016-02-18
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Predicate methods, aka. question-mark methods, such as `def x?; @x; end` are
+# acceptable. See https://github.com/bbatsov/rubocop/issues/2736 for discussion.
+Style/TrivialAccessors:
+  AllowPredicates: true
+
+# Use numbers wherever you like in your variables. Who cares.
+Style/VariableNumber:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+# template_params Changelog
+
+## 0.1.1 (2016-10-10)
+
+Just updating a few development tools and writing a little documentation.
+
+Breaking changes
+
+- None
+
+New features
+
+- None
+
+Fixed
+
+- None
+
+## 0.1.0
+
+Initial release

data/Gemfile

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

data/README.md

@@ -1,37 +1,37 @@
 # 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.
+Runtime type-check for **template preconditions**, including instance variables and local
+variables. Think of this as the method signature of a template, as the **documentation**.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+1. Add it to your Gemfile and run `bundle`.
 
-```ruby
-gem 'template_params'
-```
+    ```ruby
+    gem 'template_params'
+    ```
 
-then run `bundle`.
+2. If you're using rails, add a helper method.
 
-## Usage
+   ```ruby
+   # app/helpers/application_helper.rb
+   def template_param(*args, &block)
+     ::TemplateParams::Assertion.assert(*args, &block)
+   end
+   ```
 
-In rails, you may want a helper method like this:
+  If you're not using rails, let me know how you install it, and I'll put that here.
 
-```ruby
-# app/helpers/application_helper.rb
-require "template_params"
-def template_param(*args, &block)
-  ::TemplateParams::Assertion.assert(*args, &block)
-end
+## Usage
 
+```ruby
 # Assert `poll` is defined. If not, raises an `ArgumentError` (the "arguments"
 # of the template are invalid).
-template_param { poll } 
+template_param { poll }
 
 # Assert `@course` is defined. Meaningless because instance variables are
 # always defined.
-template_param { @course } 
+template_param { @course }
 
 # Assert `poll.is_a?(::Poll)`. If not, raises a `TypeError`.
 template_param(::Poll) { poll }

data/Rakefile

@@ -1,6 +1,15 @@
+# frozen_string_literal: true
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+require "rubocop/rake_task"
+RuboCop::RakeTask.new
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.verbose = false
+end
 
-task :default => :spec
+# Default task: lint then test
+task default: [] # in case it hasn't been set
+Rake::Task[:default].clear
+task default: [:rubocop, :spec]

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "template_params"

data/bin/rake

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rake", "rake")

data/bin/rubocop

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rubocop", "rubocop")

data/lib/template_params.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
 require "template_params/version"
 require "template_params/assertion"
 
+# Runtime type-checks for template preconditions.
 module TemplateParams
 end

data/lib/template_params/assertion.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
 require "method_source"
 
 module TemplateParams
+  # A simple assertion suitable for view template preconditions.
   class Assertion
-
     # @api public
     def initialize(type, options)
       @type = type
@@ -45,7 +46,7 @@ module TemplateParams
     # @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)
+        raise TypeError, format("Expected %s, got %s", @type, value.class)
       end
     end
 
@@ -59,11 +60,12 @@ module TemplateParams
     #
     # @api private
     def udef_msg(name_error, block)
-      msg = "Undefined template parameter: #{name_error}"
+      prefix = "Undefined template parameter: #{name_error}"
       if block.respond_to?(:source)
-        msg << ": " + block.source.strip
+        format("%s: %s", prefix, block.source.strip)
+      else
+        prefix
       end
-      msg
     end
   end
 end

data/lib/template_params/version.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module TemplateParams
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/template_params.gemspec

@@ -1,22 +1,26 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'template_params/version'
+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.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"
+  spec.add_development_dependency "rubocop"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: template_params
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jared Beck
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-30 00:00:00.000000000 Z
+date: 2016-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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
@@ -75,13 +89,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
+- bin/rake
+- bin/rubocop
 - bin/setup
 - lib/template_params.rb
 - lib/template_params/assertion.rb
@@ -107,7 +125,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Parameter assertions for your view templates