settingable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 44dd382347efa4660d7eb7329684165b25a9326b
+  data.tar.gz: 7516072936d6a315e5bbf2322721bf17d39f7e86
+SHA512:
+  metadata.gz: 5625c2068e64528122c1fe8d3e927e52a1b431629093c1d079bdb7d4b81fba78dd49a7c517dc6443df8f061f58f087e4bdef8e7656aab0d0abf25d3fde60fd70
+  data.tar.gz: 0b8a3f1bf9c29345be135fdee6ec86fc76bd219e79d1132ab035e972d33173e3d2efc9bc901141e53f38a7324afa24f2e7be4e35f9d877ac3331d44ddeba08aa

data/.document

@@ -0,0 +1,3 @@
+- 
+ChangeLog.md
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,4 @@
+Gemfile.lock
+doc/
+pkg/
+vendor/cache/*.gem

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title "settingable Documentation" --protected

data/ChangeLog.md

@@ -0,0 +1,4 @@
+### 0.1.0 / 2015-06-25
+
+* Initial release:
+

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Jeremy Rodi
+
+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,27 @@
+# settingable
+
+* [Homepage](https://rubygems.org/gems/settingable)
+* [Documentation](http://rubydoc.info/gems/settingable/frames)
+* [Email](mailto:redjazz96@gmail.com)
+
+## Description
+
+TODO: Description
+
+## Features
+
+## Examples
+
+    require 'settingable'
+
+## Requirements
+
+## Install
+
+    $ gem install settingable
+
+## Copyright
+
+Copyright (c) 2015 Jeremy Rodi
+
+See {file:LICENSE.txt} for details.

data/Rakefile

@@ -0,0 +1,13 @@
+# encoding: utf-8
+# rubocop:disable Style/HashSyntax
+require "rake"
+require "yard"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+YARD::Rake::YardocTask.new
+
+task :test => :spec
+task :default => :spec
+task :doc => :yard

data/lib/settingable/settings.rb

@@ -0,0 +1,107 @@
+require "forwardable"
+
+module Settingable
+  # A module containing the settings configuration.
+  module Settings
+    # The class methods for the Settings module.
+    module ClassMethods
+      extend Forwardable
+
+      def_delegators :settings, :[], :[]=, :fetch,
+                     :method_missing
+      def_delegator :settings, :build, :configure
+
+      # Returns an instance of the included module.  Repeated calls
+      # return the same instance.
+      #
+      # @return [Settings]
+      def settings
+        @_settings ||= new
+      end
+
+      # @!method default_settings
+      #   Retrieves the default settings.  If there are no defaults,
+      #   it returns an empty hash.
+      #
+      #   @return [Hash]
+      #
+      # @!method default_settings(value)
+      #   Sets the default settings.
+      #
+      #   @param value [Hash] The default settings.
+      #   @return [void]
+      def default_settings(value = nil)
+        if value
+          @_default_settings = value
+        else
+          @_default_settings || {}
+        end
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    extend Forwardable
+    def_delegators :@settings, :fetch
+
+    # Initialize the settings.  Merges the given settings to the default
+    # settings.
+    #
+    # @param settings [Hash] The initial settings.
+    def initialize(settings = {})
+      @settings = self.class.default_settings.merge(settings)
+    end
+
+    # Builds the settings construct.  It yields itself, and then returns
+    # itself.
+    #
+    # @yield
+    # @return [self]
+    def build
+      yield self
+      self
+    end
+
+    # Sets a key to a value.
+    #
+    # @param key [Symbol, String] The key.
+    # @param value [Object] The value.
+    # @return [void]
+    def []=(key, value)
+      @settings[key.to_s.to_sym] = value
+    end
+
+    # Retrieves a key.  If it doesn't exist, it errors.
+    #
+    # @param key [Symbol, String] The key.
+    # @return [Object]
+    def [](key)
+      @settings.fetch(key.to_s.to_sym)
+    end
+
+    # Method missing.  For set methods, it maps to the `:[]=` method; for
+    # regular methods (i.e. not bang or ? methods), it maps to the `:[]`
+    # method.
+    #
+    # @return [Object]
+    def method_missing(method, *args, &block)
+      return super if args.length > 1 || block_given? || method =~ /(\?|\!)\z/
+      map_method(method, args)
+    end
+
+    private
+
+    # Maps the methods.
+    def map_method(method, args)
+      if method =~ /\A(.*)\=\z/ && args.length == 1
+        self[$+] = args[0]
+      elsif args.length == 0
+        self[method.to_s]
+      else
+        fail NameError, "Undefined method `#{method}' called on #{self}"
+      end
+    end
+  end
+end

data/lib/settingable/version.rb

@@ -0,0 +1,4 @@
+module Settingable
+  # settingable version
+  VERSION = "0.1.0"
+end

data/lib/settingable.rb

@@ -0,0 +1,6 @@
+require "settingable/version"
+require "settingable/settings"
+
+# Contains the Setting module.
+module Settingable
+end

data/settingable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path("../lib/settingable/version", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = "settingable"
+  gem.version       = Settingable::VERSION
+  gem.summary       = "Handles configuring your gems."
+  gem.description   = "Handles configuring your gems."
+  gem.license       = "MIT"
+  gem.authors       = ["Jeremy Rodi"]
+  gem.email         = "redjazz96@gmail.com"
+  gem.homepage      = "https://github.com/medcat/settingable"
+
+  gem.files         = `git ls-files`.split($RS)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "yard"
+end

data/spec/settingable/settings_spec.rb

@@ -0,0 +1,76 @@
+require "spec_helper"
+
+# Test module for Setting.
+class Configuration
+  def self.reset!
+    @_settings = nil
+    @_default_settings = nil
+  end
+
+  include Settingable::Settings
+end
+
+RSpec.describe Settingable::Settings do
+  subject { Configuration.settings }
+  before(:each) { Configuration.reset! }
+
+  it "extends the base" do
+    ancestors = (class << Configuration; self; end).ancestors
+    expect(ancestors)
+      .to include(Settingable::Settings::ClassMethods)
+  end
+
+  describe ".settings" do
+    it "returns the same instance" do
+      expect(Configuration.settings).to be_a(Configuration)
+      expect(Configuration.settings).to be(Configuration.settings)
+    end
+  end
+
+  describe ".configure" do
+    it "yields itself" do
+      expect { |b| Configuration.configure(&b) }.to yield_with_args(subject)
+    end
+
+    it "returns itself" do
+      expect(Configuration.configure {}).to be subject
+    end
+  end
+
+  describe ".[]" do
+    it "maps to the .settings instance" do
+      subject[:hello] = "world"
+      expect(Configuration[:hello]).to eq "world"
+      expect(Configuration[:hello]).to be subject[:hello]
+    end
+  end
+
+  describe "#initialize" do
+    subject { Configuration.new(settings) }
+    let(:settings) { { foo: "bar" }.freeze }
+    let(:defaults) { { hello: "world", foo: "baz" }.freeze }
+    before(:each) { Configuration.default_settings(defaults) }
+
+    it "merges instance variables" do
+      expect(subject[:hello]).to eq "world"
+      expect(subject[:foo]).to eq "bar"
+    end
+
+    it "doesn't modify defaults" do
+      subject[:hello] = "you"
+      expect(defaults[:hello]).to eq "world"
+    end
+  end
+
+  describe "#method_missing" do
+    it "maps the correct methods" do
+      subject[:hello] = "world"
+      expect(subject.hello).to eq("world")
+      expect(subject.hello).to be subject[:hello]
+
+      subject.foo = "bar"
+      expect(subject[:foo]).to eq("bar")
+      expect(subject[:foo]).to be subject.foo
+    end
+  end
+end

data/spec/settingable_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "settingable"
+
+describe Settingable do
+  it "should have a VERSION constant" do
+    expect(subject.const_get("VERSION")).to_not be_empty
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require "rspec"
+require "settingable"
+
+include Settingable

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: settingable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Rodi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: Handles configuring your gems.
+email: redjazz96@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".document"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".yardopts"
+- ChangeLog.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/settingable.rb
+- lib/settingable/settings.rb
+- lib/settingable/version.rb
+- settingable.gemspec
+- spec/settingable/settings_spec.rb
+- spec/settingable_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/medcat/settingable
+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: Handles configuring your gems.
+test_files:
+- spec/settingable/settings_spec.rb
+- spec/settingable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: