k-configurable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c902e0cd7fa3ae73408d2a3a24e05f6a3a714c5d
+  data.tar.gz: a669bac3b208038ed8776b2803e3b8bee05f73a5
+SHA512:
+  metadata.gz: 56ac5d2b2ef12792a70b0fb395fd4a4eff1677f750ec27c1901352a2698497e583d67458e0eb867151c426819a46ffe31c7738e101ede09fd136e5b2fc9511f2
+  data.tar.gz: a13c1ed2866e56fe31ae39b270b1a573afefe8377e61f0f1ba3697734f1de4715c26237ef5f8b86ff22995587a68253df1c6ad14a172963e203624655b2983a2

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.14.6

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kai Kuchenbecker
+
+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,123 @@
+# K-Configurable
+
+Make your classes configurable with this nifty little gem. Instead of
+implementing this over and over again, or copying it over and over again into
+every project where I need this, I decided to extract this tiny gem.
+Feel free to use it.
+
+There are other gems that do something similiar with a different syntax, e.g.:
+
+1. [dry-configurable](https://github.com/dry-rb/dry-configurable)
+2. [Configurable](https://github.com/thinkerbot/configurable)
+3. [simply_configurable](https://github.com/daws/simply_configurable)
+4. [ruby-configurable](https://bitbucket.org/krbullock/configurable)
+5. [block_configurable](https://github.com/artemshitov/block_configurable)
+
+Without have looked too much at those, dry-configurable is probably the best
+choice since the guys over at dry have quite a few mini gems they maintain and
+use. Also, there are many, many more than those up there.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'k-configurable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install k-configurable
+
+## Usage
+
+Include the `K::Configurable` module in the class definition body of the class
+you would like to make configurable. For example, maybe you need to wrap a
+database connection with an adapter:
+
+```ruby
+class DatabaseAdapter
+  # make host, port, user and password configurable
+  include K::Configurable[:host, :port, :user, :password]
+  
+  # ...
+  
+  # use configurable attributes to open a connection
+  # which may look something like this:
+  def connection
+    config = self.class.configuration
+    Connection.open(
+      "#{config.user}:#{config.password}@#{config.host}:#{config.port}"
+    )
+  end
+end
+
+# configure it
+DatabaseAdapter.configure do |config|
+  config.host = 'localhost'
+  config.port = '12345'
+  config.user = 'foo'
+  config.password = File.read('/run/secrets/dbpassword')
+end
+```
+
+The configuration attributes are accessible via the `configuration` class method
+since I don't want them to pollute the class interface. If you however find it
+tedious to always have to refer to `configuration` and don't mind having those
+attribute setter and getter methods on your classes interface, then simply add
+some forwardables like this:
+
+```ruby
+class DatabaseAdapter
+  include K::Configurable[:host, :port, :user, :password]
+  extend SingleForwardable
+  def_single_delegators :configuration, :host, :port, :user, :password
+end
+```
+
+Be careful about name collisions though. E.g., `name` would be a very bad
+attribute to delegate.
+
+### Configurable with Defaults
+
+You can specify defaults like this:
+
+```ruby
+class DatabaseAdapter
+  include K::Configurable[:user, :password, host: 'localhost', port: 12345]
+end
+```
+
+Defaults are implemented using named parameters, therefore you have to mind all
+the same rules you do when invoking any method in Ruby. I.e., you cannot mix
+named parameters and normal parameters, they have to be strictly ordered, normal
+parameters first, then named parameters.
+
+### Define methods on configuration
+
+**Do NOT use**
+
+It is possible to define methods during configuration definition, however, I do
+not like the way it is implemented and really have used it only in one instance
+yet. So use at own risk it may change without further notice. If you absolutely
+want to use it, it is at your own risk.. See the tests on how it works.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also 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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kaikuchn/k-configurable.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "configurable"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/k-configurable.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'k/configurable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'k-configurable'
+  spec.version       = K::Configurable::VERSION
+  spec.authors       = ['Kai Kuchenbecker']
+  spec.email         = ['kuchenbecker.k@gmail.com']
+
+  spec.summary       = %q{Make your classes configurable.}
+  spec.homepage      = 'https://github.com/kaikuchn/configurable.git'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+end

data/lib/k/configurable.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+require 'k/configurable/version'
+
+module K
+  module Configurable
+    def self.included(_base)
+      raise 'Cannot include Configurable, include Configurable::[] instead'
+    end
+
+    # Use `include Configurable [:foo, :bar]` to make your class/module
+    # configurable with configuration options :foo and :bar. If you want your
+    # configuration object to be able to respond to some custom methods you can
+    # extend it by passing a block. In that case you have to call `[]` like this
+    # include(Configurable.[](:foo) do
+    #   def bazinga
+    #     ...
+    #   end
+    # end)
+    # Because MRI cannot parse `Configurable[...] {}`. Also keep in mind that
+    # the do-end block would get bound to `include` without the parens, you
+    # could also use {}-block instead, which binds tighter.
+    def self.[](*attributes, **defaults, &block)
+      Module.new do
+        @__attributes = (attributes + defaults.keys).uniq
+        @__defaults = defaults
+        @__block = block || -> {}
+
+        def self.included(base)
+          base.instance_variable_set(:@__configurable_attributes, @__attributes)
+          base.instance_variable_set(:@__configurable_defaults, @__defaults)
+          base.instance_variable_set(:@__configurable_block, @__block)
+          base.extend(ClassMethods)
+        end
+      end
+    end
+
+    module ClassMethods
+      def configuration
+        @configuration ||= anonymous_configuration_class.new(
+          *__configurable_defaults
+        )
+      end
+
+      def configure
+        yield(configuration)
+      end
+
+      private
+
+      def anonymous_configuration_class
+        block = __configurable_block
+        Struct.new(*__configurable_attributes) do |klass|
+          klass.class_exec(&block)
+
+          def to_params
+            Hash[
+              members
+              .map { |attr| [attr, public_send(attr)] }
+              .reject { |_, value| value.nil? }
+            ]
+          end
+        end
+      end
+
+      def __configurable_attributes
+        @__configurable_attributes
+      end
+
+      def __configurable_defaults
+        @__configurable_defaults.values_at(*__configurable_attributes)
+      end
+
+      def __configurable_block
+        @__configurable_block
+      end
+    end
+  end
+end

data/lib/k/configurable/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module K
+  module Configurable
+    VERSION = '0.1.0'.freeze
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: k-configurable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kai Kuchenbecker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- kuchenbecker.k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- k-configurable.gemspec
+- lib/k/configurable.rb
+- lib/k/configurable/version.rb
+homepage: https://github.com/kaikuchn/configurable.git
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6.11
+signing_key: 
+specification_version: 4
+summary: Make your classes configurable.
+test_files: []