dot_configure 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 892831f35dc73723c677c0278bb976b642f9e559
+  data.tar.gz: bfdb7f99a65ecd6fa8341e503d8cfe5cd90e8498
+SHA512:
+  metadata.gz: 493b8d5fdc8c7e544328eb5c9c0c3bac6c25d3ade8e4deaa379a185d802556c39c6a90126348d25c51a597bbec92ffd6de830959e5ead85f643052202de56c41
+  data.tar.gz: eec8a37edf42c8f73b01cd401c3bad2d31cc9e1f9ff73259b4402eb85f48c2daf3f009e64cf751fa44c6a79462397cd15b89df2d70555c19aa55efe025c25536

data/.gitignore

@@ -0,0 +1,23 @@
+*.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
+.DS_Store*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Joseph Lorich (joseph@lorich.me)
+
+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,72 @@
+# .configure
+
+Easily add configuration options to classes, modules, and object instances.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dot_configure'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+#####Extend DotConfigure to provide Class and Module level options
+
+    class TestClass
+      extend DotConfigure
+    end
+
+`TestClass` will now have a configure method and options!
+
+    TestClass.configure do |config|
+      config.dot_configure_rules = true
+    end
+    
+    => #<DotConfigure::Options dot_configure_rules=true>
+
+The resulting options are now available at `TestClass.options`
+
+#####Include DotConfigure to provide instance level options
+When you `include` dotconfigure, rather than extend, you get all the Class/Module level options, but also get seperate instance-level options objects.
+
+    class TestClass
+      include DotConfigure
+    end
+
+    > `TestClass.new.options`
+    => #<DotConfigure::Options>
+  
+Class/Module and instance level options are completely separate so each individual object can have it's own information.
+
+#####DotConfigure::Options
+The options returned are an [OpenStruct](http://www.ruby-doc.org/stdlib-2.0/libdoc/ostruct/rdoc/OpenStruct.html) that has been extended in `dot_configure/options.rb` to allow for specific monkey-patching if desired.  OpenStructs allow for hash, string and dot access to any values.
+
+    > `TestClass.options.dot_configure_rules`
+    => true
+    
+    > `TestClass.options[:dot_configure_rules]`
+    => true
+    
+    > `TestClass.options['dot_configure_rules']`
+    => true
+
+#####Locking
+When calling `configure` can also pass in `lock: true` to prevent further write access to the options.  Once configured with the lock setting, any subsequent attempts to call `.configure` will fail.  Also, calls to `.options` will return a cloned options hash so modifications will not be saved.
+
+To call a locking configure method simply set the keyword argument:
+
+    TestClass.configure(lock: true) do |config|
+      config.dot_configure_rules = true
+    end
+
+## Contributing
+
+1. Fork it ( https://github.com/jlorich/dot_configure/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/dot_configure.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dot_configure/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dot_configure"
+  spec.version       = DotConfigure::VERSION
+  spec.authors       = ["Joey Lorich"]
+  spec.email         = ["jospeh@lorich.me"]
+  spec.summary       = %q{Simple configuration options}
+  spec.description   = %q{Simple configuration options}
+  spec.homepage      = ""
+  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 'rake', '~> 10.3.2'
+  spec.add_development_dependency 'pry-byebug', '~> 1.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.0.0'
+  spec.add_development_dependency 'clint_eastwood', '~> 0.0.1'
+end

data/lib/dot_configure.rb

@@ -0,0 +1 @@
+require 'dot_configure/dot_configure'

data/lib/dot_configure/dot_configure.rb

@@ -0,0 +1,32 @@
+require 'dot_configure/options'
+
+# A configureable options implementation for any module
+module DotConfigure
+  def self.included(base)
+    base.extend(DotConfigure)
+  end
+
+  # Memoizes the configuration
+  def options
+    @options ||= Options.new(default_options)
+
+    @options.locked? ? @options.clone : @options
+  end
+
+  # Configure the options
+  def configure(lock: false)
+    fail 'You must specify a configuration block when calling configure' unless block_given?
+    fail 'Configuration already set' if options.locked?
+    yield(options)
+
+    options.locked = lock
+    options
+  end
+
+  private
+
+  # Customizable default options
+  def default_options
+    {}
+  end
+end

data/lib/dot_configure/options.rb

@@ -0,0 +1,12 @@
+require 'ostruct'
+
+module DotConfigure
+  # Customizable configuration class
+  class Options < OpenStruct
+    attr_accessor :locked
+
+    def locked?
+      locked || false
+    end
+  end
+end

data/lib/dot_configure/version.rb

@@ -0,0 +1,4 @@
+# DotConfigure parent module
+module DotConfigure
+  VERSION = '0.0.1'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,81 @@
+require 'pry-byebug'
+require 'dot_configure'
+
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  config.color = true
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: dot_configure
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Joey Lorich
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-16 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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 10.3.2
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !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.0
+- !ruby/object:Gem::Dependency
+  name: clint_eastwood
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+description: Simple configuration options
+email:
+- jospeh@lorich.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dot_configure.gemspec
+- lib/dot_configure.rb
+- lib/dot_configure/dot_configure.rb
+- lib/dot_configure/options.rb
+- lib/dot_configure/version.rb
+- spec/dot_configure/dot_configure_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Simple configuration options
+test_files:
+- spec/dot_configure/dot_configure_spec.rb
+- spec/spec_helper.rb