kungfuig 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3f6ba2a2d65c5d77ce06bd93df7f1c98e97211a7
+  data.tar.gz: b0088e41cc0db5dd9797dc05432151432a2a1e52
+SHA512:
+  metadata.gz: 1162a74661dabaf6f796ff1ff78ee98ccf5b9bf76144c60f7ed6b81d2dc4fe4cdacce2b0190a22d6353a99381f1de33b4501560e9937bb0938dbf20ac2cae61e
+  data.tar.gz: 53d68ae2b530834e31fbd191387c4bc625f47c193bfdb29e59c3abc69aa4a83c2b64c1fa59acc04c5518ae22f9fa225821c3327008d67d9694ede03853275c46

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,86 @@
+# Kungfuig
+
+**Kungfuig** (_pronounced: [ˌkʌŋˈfig]_) provides a drastically easy way to plug configuration into everything.
+
+[![Build Status](https://travis-ci.org/am-kantox/kungfuig.svg\?branch\=master)](https://travis-ci.org/am-kantox/kungfuig)
+
+Configuration is thread-safe (starting with `0.2.0`).
+
+## Usage
+
+```ruby
+class MyApp
+  include Kungfuig
+end
+
+# Load configuration file
+MyApp.config('config/myapp.yml')
+
+# Append options explicitly
+MyApp.config do |options|
+  options.value = 42
+end
+
+# load options from JSON file and execute block on it
+MyApp.config('config/myapp.json') do |options|
+  options.other_value = options[:value]
+end
+
+# DSL (note `kungfuig` method name)
+MyApp.kungfuig do
+  set :value, 42
+end
+```
+
+### Plugin to be called on method execution
+
+```ruby
+class MyApp
+  include Kungfuig
+  def report
+    # ...
+    42
+  end
+end
+
+MyApp.kungfuig do
+  plugin :report do |result|
+    puts "MyApp#report returned #{result}"
+  end
+end
+
+MyApp.new.report
+#⇒ "MyApp#report returned 42"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'kungfuig'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kungfuig
+
+## Include/extend each class/instance you want to have configuration options
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/kungfuig/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,28 @@
+# encoding: UTF-8
+require 'rubygems'
+
+require 'bundler'
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+begin
+  Bundler.setup(:default, :development, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+desc 'Tests'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = '-Ispec'
+  #  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+desc 'Cucumber'
+Cucumber::Rake::Task.new(:features)
+
+task default: [:features, :spec]

data/kungfuig.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kungfuig/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'kungfuig'
+  spec.version       = Kungfuig::VERSION
+  spec.authors       = ['Kantox LTD']
+  spec.email         = ['aleksei.matiushkin@kantox.com']
+  spec.licenses      = ['MIT']
+
+  spec.summary       = 'Simple but powerful config for any gem.'
+  spec.description   = 'Config with goodnesses.'
+  spec.homepage      = 'http://kantox.com'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(/\A(test|spec|features)\//) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(/\Abin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.metadata['allowed_push_host'] = 'http://mygemserver.com' if spec.respond_to?(:metadata)
+
+  spec.add_dependency 'hashie', '~> 3'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_development_dependency 'rspec', '~> 2.12'
+  spec.add_development_dependency 'cucumber', '~> 1.3'
+  spec.add_development_dependency 'yard', '~> 0'
+end

data/lib/kungfuig/version.rb

@@ -0,0 +1,3 @@
+module Kungfuig
+  VERSION = "0.3.0"
+end

data/lib/kungfuig.rb

@@ -0,0 +1,134 @@
+require 'kungfuig/version'
+require 'yaml'
+require 'hashie'
+
+module Kungfuig
+  MX = Mutex.new
+
+  module InstanceMethods
+    # Configures everything by hash or yaml from string or file. Whether code block
+    #   is passed, it is processed with @options instance.
+    # @param hos [String|Hash|Hashie::Mash] the input data to merge into options
+    def config hos = nil
+      MX.synchronize {
+        merge_hash_or_string! hos
+        yield options if block_given?
+        options
+      }
+    end
+
+    # Options getter
+    # @return [Hashie::Mash] options
+    def options
+      @options ||= Hashie::Mash.new
+    end
+    private :options
+
+    # Accepts:
+    #     option :foo, :bar: baz
+    #     option [:foo, 'bar', 'baz']
+    #     option 'foo.bar.baz'
+    #     option 'foo::bar::baz'
+    def option *keys
+      key = keys.join('.').gsub(/::/, '.').split('.')
+
+      MX.synchronize {
+        # options.foo!.bar!.baz!
+        build = [key, key[1..-1]].map do |candidate|
+          candidate.inject(options.dup) do |memo, k|
+            memo.public_send("#{k}") unless memo.nil?
+          end
+        end.reduce(nil) do |memo, candidate|
+          memo || candidate
+        end
+      }
+    end
+
+    # Accepts:
+    #     option! [:foo, 'bar', 'baz'], value
+    #     option! 'foo.bar.baz', value
+    #     option! 'foo::bar::baz', value
+    def option! keys, value
+      key = (keys.is_a?(Array) ? keys.join('.') : keys).gsub(/::/, '.').split('.')
+      last = key.pop
+
+      MX.synchronize {
+        # options.foo!.bar!.baz! = value
+        build = key.inject(options) do |memo, k|
+          memo.public_send("#{k}!")
+        end
+        build[last] = value
+      }
+    end
+
+    def option? *keys
+      !option(*keys).nil?
+    end
+
+    # @param hos [Hash|String] the new values taken from hash,
+    #   mash or string (when string, should be either valid YAML file name or
+    #   string with valid YAML)
+    def merge_hash_or_string! hos
+      options.deep_merge! case hos
+                          when NilClass then {} # aka skip
+                          when Hash then hos
+                          when String
+                            begin
+                              File.exists?(hos) ? Hashie::Mash.load(hos) : Hashie::Mash.new(YAML.load(hos))
+                            rescue ArgumentError => ae
+                              fail ArgumentError.new "#{__callee__} expects valid YAML configuration file. [#{hos}] contains invalid syntax."
+                            rescue Psych::SyntaxError => pse
+                              fail ArgumentError.new "#{__callee__} expects valid YAML configuration string. Got:\n#{hos}"
+                            end
+                          else
+                            fail ArgumentError.new "#{__callee__} accepts either String or Hash as parameter."
+                          end
+    end
+    private :merge_hash_or_string!
+  end
+
+  def self.included base
+    base.include InstanceMethods
+    base.extend ClassMethods
+    if (base.instance_methods & [:[], :[]=]).empty?
+      base.send :alias_method, :[], :option
+      base.send :alias_method, :[]=, :option!
+    end
+  end
+
+  def self.extended base
+    base.include ClassMethods
+  end
+
+  module ClassMethods
+    include InstanceMethods
+
+    # A wrapper for the configuration block
+    # @param block the block to be executed in the context of this module
+    def kungfuig &block
+      instance_eval(&block)
+    end
+
+    def plugin meth
+      fail ArgumentError.new "Plugin must have a codeblock" unless block_given?
+      fail NoMethodError.new "Plugin must be attached to existing method" unless instance_methods.include? meth.to_sym
+
+      ((@plugins ||= {})[meth.to_sym] ||= []) << Proc.new
+      plugins = @plugins
+      class_eval do
+        unless instance_methods(true).include?(:"∃#{meth}")
+          alias_method :"∃#{meth}", meth.to_sym
+          define_method meth.to_sym do |*args|
+            send(:"∃#{meth}", *args).tap do |result|
+              plugins[meth.to_sym].each do |p|
+                p.call result
+              end
+            end
+          end
+        end
+
+      end
+    end
+    alias_method :set, :option!
+  end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: kungfuig
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Kantox LTD
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.12'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: Config with goodnesses.
+email:
+- aleksei.matiushkin@kantox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- kungfuig.gemspec
+- lib/kungfuig.rb
+- lib/kungfuig/version.rb
+homepage: http://kantox.com
+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.8
+signing_key: 
+specification_version: 4
+summary: Simple but powerful config for any gem.
+test_files: []
+has_rdoc: