optionally 0.0.3

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODliNDViMjMyMzQ2NjM3YTI4NjE0OWQ1NzI2NWE5YjBmMzQ0MmM2Mg==
+  data.tar.gz: !binary |-
+    MzNmMmU1MTE4MmY4NjUzMzRiMzcwODg5Mzc2ZDNiMTMzOWU2ZDY0Mw==
+SHA512:
+  metadata.gz: !binary |-
+    OTM2Y2JmZGE0M2EzYmQ1ODBlNWI5MDRiNjNkN2FiODhkNjlhNjBkMGQ2MmI1
+    NWU4YTYwOTMyYTUzYzJlZGVlMmE4MjBmMmE1ZTU5ZjFiOGZhYzkzZDEyNWRk
+    M2UxMmFjOTE2YWNhNzExMmY4NDczZWNlOTQzNjY5ZjBmZTdjNjk=
+  data.tar.gz: !binary |-
+    MDA5NDFmMTAwNzI3MGQwYjgyMTMwZDljYjk5MDgwYjcwYmQyMmE3NDY1YTQ4
+    NWVmODMyZDU5MDE5OThmNmMwMTI5ZTllOTEzMWIxZTdkMDM5YWViMzRhZDE2
+    NzA2MjlkZGRlMzE3YjkzNjgzNTA0YTQyMDllZGNiYzFkMmE4NWY=

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*~
+*.swp
+*.bak

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Dennis Walters
+
+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,58 @@
+# Optionally
+
+This is, like, so totally just a tiny little mix-in that lets your classes
+be super cereals about the stuff their methods get in options hashes, fersure.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'optionally'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install optionally
+
+## Usage
+
+```ruby
+require 'optionally'
+
+class Something
+  include Optionally::Required
+
+  def fersure(options = {})
+    check_required_options(options, :totally)
+
+    puts "totally #{options[:totally]}"
+  end
+end
+
+s = Something.new
+s.fersure(totally: 'like, freal')
+#  "totally like, freal"
+#  => nil
+
+s.fersure(bummer: "gag me with a spoon")
+#  ArgumentError: totally is required
+#  Big Ugly Stacktrace (TM)
+```
+
+## Contributing ##
+
+Do you use git-flow? I sure do. Please base anything you do off of
+[the develop branch](https://github.com/ess/optionally/tree/develop).
+
+1. Fork it.
+2. Perform some BDD magic. Seriously. Be testing.
+3. Submit a pull request.
+
+## License ##
+
+MIT License. Copyright 2015 Dennis Walters

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "optionally"
+
+# 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/optionally.rb

@@ -0,0 +1,5 @@
+require "optionally/version"
+require "optionally/required"
+
+module Optionally
+end

data/lib/optionally/required.rb

@@ -0,0 +1,16 @@
+module Optionally
+  module Required
+    def self.included(base)
+      base.extend(self)
+    end
+
+    def check_required_options(candidate, *required_keys)
+      required_keys.each do |key|
+        unless candidate.keys.include?(key)
+          raise ArgumentError.new("#{key} is required")
+        end
+      end
+      true
+    end
+  end
+end

data/lib/optionally/version.rb

@@ -0,0 +1,3 @@
+module Optionally
+  VERSION = "0.0.3"
+end

data/optionally.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'optionally/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "optionally"
+  spec.version       = Optionally::VERSION
+  spec.authors       = ["Dennis Walters"]
+  spec.email         = ["pooster@gmail.com"]
+
+  spec.summary       = %q{Quick and dirty required fields for options hashes}
+  spec.homepage      = "https://github.com/ess/optionally"
+  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.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: optionally
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Dennis Walters
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: 
+email:
+- pooster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/optionally.rb
+- lib/optionally/required.rb
+- lib/optionally/version.rb
+- optionally.gemspec
+homepage: https://github.com/ess/optionally
+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
+signing_key: 
+specification_version: 4
+summary: Quick and dirty required fields for options hashes
+test_files: []