default_options 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2df275a34037e316ac5aeda858bc4c4fc4c2f446
+  data.tar.gz: d1569d20650db07a6549d4689faaca9b4b804db8
+SHA512:
+  metadata.gz: 4e31dfafe075d4270cd604a6369ed4745350064c0dfa58402ddcee01e904b4909fc04ff505f5c3e1d7606ca372d5a8a6a6728f238428367f6e614055d9100818
+  data.tar.gz: a04c893ca72a9af025687f8b6cfccd9e2b4015cb96b96fee6fe39a2e93d2a8a2fc407737e4fac6076f3fdd82880d0cf425ad777f15852d470b95352054e80442

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 John Mertens
+
+MIT License
+
+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,73 @@
+# DefaultOptions
+
+Super simple library provides an easy DSL for setting default options in methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'default_options'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install default_options
+
+## Usage
+
+Let's say you have a method that returns the number of views a particular blog post receives. This
+method also accepts a hash of options to allow use to limit the number of views returned to a
+particular date range:
+
+**This is a Rails example, but the library works in any Ruby project**
+
+```
+def blog_views(opts = {})
+  default_options = {
+    :start_date => self.created_at,
+    :end_date => Time.zone.now
+  }
+  options = opts.reverse_merge(default_options)
+
+  self.views.where(:start_date => options[:start_date], :end_date => options[:end_date]).count
+end
+```
+
+With DefaultOptions, this same code would look like:
+
+```
+def blog_views(opts = {})
+  options = defaults_for opts do
+    start_date self.created_at
+    end_date Time.zone.now
+  end
+
+  self.views.where(:start_date => options.start_date, :end_date => options.end_date).count
+end
+```
+
+To add this functionality to any Ruby class, just include the library.
+
+```
+require 'default_options' # If you are using Rails, you don't need this line
+
+class AwesomeSauce
+  include DefautOptions
+
+  def rad_thing(opts = {})
+	…
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/mertonium/default_options/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

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

data/default_options.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'default_options/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "default_options"
+  spec.version       = DefaultOptions::VERSION
+  spec.authors       = ["John Mertens"]
+  spec.email         = ["john@versahq.com"]
+  spec.summary       = %q{Super simple library provides an easy DSL for setting defaults on optional methods arguments.}
+  spec.description   = %q{Implements a simple pattern for creating "options" in Ruby method. Mix it in to a class and use the DSL to setup defaults for methods that can easily be overwritten as needed.}
+  spec.homepage      = "https://github.com/mertonium/default_options"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
+end

data/lib/default_options.rb

@@ -0,0 +1,18 @@
+require "default_options/version"
+require "default_options/parser"
+
+module DefaultOptions
+  module Macros
+    def defaults_for(opts, &block)
+      DefaultOptions::Parser.new opts, &block
+    end
+  end
+
+  def self.included(base)
+    base.extend(Macros)
+  end
+
+  def defaults_for(opts, &block)
+    DefaultOptions::Parser.new opts, &block
+  end
+end

data/lib/default_options/parser.rb

@@ -0,0 +1,27 @@
+module DefaultOptions
+  class Parser
+    def initialize(orides, &block)
+      @defaults = {}
+      overrides(orides.dup)
+      instance_eval(&block)
+    end
+
+    def overrides(orides)
+      @overrides = orides
+    end
+
+    def method_missing(method_name, *args)
+      if args.size > 0
+        @defaults[method_name] = args.first
+      else
+        if @overrides.has_key? method_name
+          @overrides[method_name]
+        else
+          @defaults[method_name]
+        end
+      end
+    end
+  end
+
+
+end

data/lib/default_options/version.rb

@@ -0,0 +1,3 @@
+module DefaultOptions
+  VERSION = "0.0.1"
+end

data/spec/default_options/parser_spec.rb

@@ -0,0 +1,41 @@
+require 'helper'
+
+class DummyClass
+  def self.dummy_method(opts = {})
+    options = DefaultOptions::Parser.new opts do
+      thing1 "foo"
+      thing2 "bar"
+    end
+
+    return options
+  end
+end
+
+describe DefaultOptions::Parser do
+  context "when no overrides are given" do
+    it "initializes the default options" do
+      result = DummyClass.dummy_method
+      expect(result.thing1).to eq('foo')
+      expect(result.thing2).to eq('bar')
+    end
+  end
+
+  context "when simple overrides are given" do
+    it "merges the defaults with the overrides" do
+      result = DummyClass.dummy_method(:thing1 => 'baz')
+      expect(result.thing1).to eq('baz')
+      expect(result.thing2).to eq('bar')
+    end
+  end
+
+  context "when non-defaulted overrides are given" do
+    it "merges the defaults with the overrides" do
+      result = DummyClass.dummy_method(:thing3 => 'baz')
+      expect(result.thing1).to eq('foo')
+      expect(result.thing2).to eq('bar')
+      expect(result.thing3).to eq('baz')
+    end
+  end
+end
+
+

data/spec/helper.rb

@@ -0,0 +1,2 @@
+require 'default_options'
+require 'rspec'

data/spec/macros_spec.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class DummyClass2
+  include DefaultOptions
+  def self.dummy_class_method(opts = {})
+    options = defaults_for opts do
+      thing1 "foo"
+      thing2 "bar"
+    end
+
+    return options
+  end
+
+  def dummy_instance_method(opts = {})
+    options = defaults_for opts do
+      thing1 "foo"
+      thing2 "bar"
+    end
+
+    return options
+  end
+end
+
+describe DefaultOptions, :new_baktun => true do
+  describe ".default_for" do
+    context "when no overrides are given" do
+      it "initializes the default options" do
+        result = DummyClass2.dummy_class_method
+        expect(result.thing1).to eq('foo')
+        expect(result.thing2).to eq('bar')
+      end
+    end
+  end
+
+  describe "#default_for" do
+    context "when no overrides are given" do
+      it "initializes the default options" do
+        result = DummyClass2.new.dummy_instance_method
+        expect(result.thing1).to eq('foo')
+        expect(result.thing2).to eq('bar')
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: default_options
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- John Mertens
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Implements a simple pattern for creating "options" in Ruby method. Mix
+  it in to a class and use the DSL to setup defaults for methods that can easily be
+  overwritten as needed.
+email:
+- john@versahq.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- default_options.gemspec
+- lib/default_options.rb
+- lib/default_options/parser.rb
+- lib/default_options/version.rb
+- spec/default_options/parser_spec.rb
+- spec/helper.rb
+- spec/macros_spec.rb
+homepage: https://github.com/mertonium/default_options
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Super simple library provides an easy DSL for setting defaults on optional
+  methods arguments.
+test_files:
+- spec/default_options/parser_spec.rb
+- spec/helper.rb
+- spec/macros_spec.rb