partial_parameters 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 23ad4d978b7773c56ca70c8497e38ad046603c7f
+  data.tar.gz: 0809ba83b2eaa372627b1b5225753a1422d6c187
+SHA512:
+  metadata.gz: 6ef115ee6ca7b51c85836e04000595917fa16e6aa7074d2cf3163ea4fb99d1a09bf47868cea943dd2462684a07da7adb180eb8daebb72a97018d5e41b9ca22e2
+  data.tar.gz: a75b9e56180de716c4dfea88004f9c9dc0ccda57c80d3c5b80430347d91cd0720bb3b18d775a612e745cf59c7675af3493b34d3ad0e815acb8061dc18cd59394

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.13.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Julien Meichelbeck
+
+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,60 @@
+
+# PartialParameters
+Make your partials reusable and self-documented by validating the given parameters in development and test environments.
+If a required parameter is missing or an unknown parameter is given, an exception will be raised.
+
+![](https://api.travis-ci.org/julien-meichelbeck/partial_parameters.svg?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'partial_parameters'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install partial_parameters
+
+Just include the module `PartialParameters` into your ApplicationHelper and you are ready to go!
+
+## Usage
+At the top of your partials, simply call the method `partial_parameters` and list your required and optional parameters:
+
+
+Erb example:
+```erb
+  <% partial_parameters { required(:name); required(:age); optional(:height) }%>
+```
+
+Slim example:
+```slim
+  - partial_parameters do
+    - required(:name)
+    - required(:age)
+    - optional(:height)
+```
+
+### Strict mode
+By default strict mode is enabled and an error will be raised if an unknown parameter has been passed to the partial. Of course, you can disable the strict mode:
+```slim
+  - partial_parameters(strict: false) do
+    - required(:name)
+    - required(:age)
+    - optional(:height)
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/julien-meichelbeck/partial_parameters.
+
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "partial_parameters"
+
+# 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,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/partial_parameters.rb

@@ -0,0 +1,33 @@
+require 'partial_parameters/version'
+require 'partial_parameters/errors'
+
+module PartialParameters
+  if ENV['RAILS_ENV'] == 'production'
+    def partial_parameters(**args); end
+  else
+    def partial_parameters(strict: true, &block)
+      raise NoBlockGivenError if block.nil?
+      raise InvalidContextError unless block.binding.local_variable_defined?(:local_assigns)
+
+      @__local_assigns = block.binding.local_variable_get(:local_assigns)
+      @__defined_parameters = []
+      yield
+      unknown_params = @__local_assigns.keys - @__defined_parameters
+      raise UnknownParametersError, unknown_params if strict && unknown_params.any?
+    ensure
+      @__defined_parameters = []
+    end
+  end
+
+  private
+
+  def required(name)
+    optional(name)
+    return if @__local_assigns.key?(name)
+    raise MissingParameterError, name
+  end
+
+  def optional(name)
+    @__defined_parameters << name
+  end
+end

data/lib/partial_parameters/errors.rb

@@ -0,0 +1,31 @@
+class InvalidContextError < StandardError
+  def to_s
+    'Cannot find partial parameters, are you in the context of a partial?'
+  end
+end
+
+class UnknownParametersError < StandardError
+  def initialize(parameters)
+    @parameters = parameters
+  end
+
+  def to_s
+    "Unknown parameters: #{@parameters}"
+  end
+end
+
+class MissingParameterError < StandardError
+  def initialize(name)
+    @name = name
+  end
+
+  def to_s
+    "Missing required parameter #{@name}."
+  end
+end
+
+class NoBlockGivenError < StandardError
+  def to_s
+    'No block given.'
+  end
+end

data/lib/partial_parameters/version.rb

@@ -0,0 +1,3 @@
+module PartialParameters
+  VERSION = '0.0.1'
+end

data/partial_parameters.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'partial_parameters/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'partial_parameters'
+  spec.version       = PartialParameters::VERSION
+  spec.authors       = ['Julien Meichelbeck']
+  spec.email         = ['julien.meichelbeck@gmail.com']
+
+  spec.summary       = 'Validate the presence of parameters or deprecated parameters in your Rails partials.'
+  spec.description   = 'Make your partials reusable and self-documented by validating the given parameters in development and test environments.'
+  spec.homepage      = 'https://github.com/julien-meichelbeck/partial_parameters'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: partial_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Julien Meichelbeck
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Make your partials reusable and self-documented by validating the given
+  parameters in development and test environments.
+email:
+- julien.meichelbeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/partial_parameters.rb
+- lib/partial_parameters/errors.rb
+- lib/partial_parameters/version.rb
+- partial_parameters.gemspec
+homepage: https://github.com/julien-meichelbeck/partial_parameters
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Validate the presence of parameters or deprecated parameters in your Rails
+  partials.
+test_files: []