config_x 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50dda4ca7833458346a6d039197b8bcd9f82ab65
+  data.tar.gz: 5d3f59ab67ec4a6e6c1fa53170faf4bc4a7acd39
+SHA512:
+  metadata.gz: 56f38f6a6fd11f65ef16449b54f7f7e4ef7909ec66a46fbf920c6938689870f45bb902d5d261a26e4aa196e3adf1f9b13a986e60accf691215685bc8a1684d68
+  data.tar.gz: 0e626869ec50ac3fbbbef79919464f10a5cd675000527ca2e9a61a3c21c383253f537a7f7119efdd560edf515e3309fc7ea40acfc49e286fbe0d8cbc481ce65f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -0,0 +1,109 @@
+# ConfigX
+
+ConfigX provides you with a simple DSL to configure classes, modules and objects. It comes with a few features:
+
+1. Default values
+2. Attr accessors
+3. Memoization of values
+4. Inheritance (You can also access the config of a class in their instances)
+5. Blocks can be evaluated within your configurable
+6. You can nest your configs
+7. You can clone your configurables. When you do that blocks will be evaluated in the cloned object. 
+8. You can call `to_h` on a config to get your config values in a hash
+
+The `configurable` method builds the interface for your configuration at parse time. All necessary methods are defined
+into modules that are then used to extend your classes and objects before you actually use them in your application. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'config_x'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install config_x
+
+## Usage
+
+### Configure on class level with `configurable :class` 
+
+```ruby
+class Client
+  extend ConfigX
+  
+  configurable :class do
+    attr :env, accessor: true do
+      attr :url, default: 'www.example.com'
+      attr :api_key, memoize: true 
+    end
+  end
+end
+
+Client.config.env.api_key { SecureRandom.hex }
+
+p Client.config.env.api_key # 2594c07670bd16dfdd48f9874d190f80
+p Client.config.env.url # www.example.com"
+p Client.config.to_h # {:env=>{:url=>"www.example.com", :api_key=>"2594c07670bd16dfdd48f9874d190f80"}}
+```
+
+### Configure on an instance level with `configurable :instance`
+
+```ruby
+class Client
+  extend ConfigX
+  
+  configurable :instance do
+    attr :env, accessor: true do
+      attr :url, default: 'www.example.com'
+      attr :api_key, memoize: true
+      attr :timeout, instance_exec: true
+    end
+  end
+  
+  def timeout 
+    5
+  end
+end
+
+client = Client.new  
+client.config.env.api_key { SecureRandom.hex }
+client.config.env.timeout { timeout } # or client.config.env.timeout { |client| client.timeout } 
+
+p client.config.env.api_key # 2594c07670bd16dfdd48f9874d190f80
+p client.config.env.url # www.example.com"
+p client.config.env.timeout # 5
+p client.config.to_h # {:env=>{:url=>"www.example.com", :api_key=>"2594c07670bd16dfdd48f9874d190f80", :timeout=>5}}
+```
+
+### `configure & configure!`
+
+You can use the `configure`method to assign values and `configure!` will freeze the underlying hash so that values are 
+safe from being overwritten. Blocks cannot be memoized when you use `configure!`
+
+```ruby
+client = Client.new
+client.configure! do |config|
+  config.env.api_key = '123123'
+  config.env.timeout = 5
+end
+```
+
+For further examples just have a look at the specs.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/Andreas Robecke/config_x.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "config_x"
+
+# 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/config_x.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'config_x/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'config_x'
+  spec.version       = ConfigX::VERSION
+  spec.authors       = ['Andreas Robecke']
+  spec.email         = ['andreas@robecke.de']
+
+  spec.summary       = %q{A simple DSL to configure classes and objects}
+  spec.description   = %q{ConfigX provides you with a simple DSL to configure classes, modules and objects}
+  spec.license = 'MIT'
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "pry"
+end

data/lib/config_x.rb

@@ -0,0 +1,34 @@
+require 'config_x/version'
+require 'config_x/namespace_delegator'
+require 'config_x/interface/base'
+require 'config_x/interface/builder'
+
+module ConfigX
+  CONFIG_NAMESPACE = 'config'
+
+  def configurable(type, &block)
+    store_maps = {}
+    config_interface = Module.new
+    owner_interface = Module.new
+
+    store_maps[type] = Interface::Builder.new(config_interface, owner_interface).build(&block)
+
+    interfaces = [
+      Interface::Base,
+      config_interface,
+      owner_interface
+    ]
+
+    inclusion_method = case type
+    when :instance
+      :include
+    when :class
+      :extend
+    else
+      raise StandardError, "Type #{type} not supported in configurable. Only :instance and :class"
+    end
+
+    interfaces.each { |interface| send inclusion_method, interface }
+    instance_variable_set(:@store_maps, store_maps)
+  end
+end

data/lib/config_x/interface/base.rb

@@ -0,0 +1,68 @@
+module ConfigX
+  module Interface
+    NAMESPACE_SEPARATOR = '->'.freeze
+    PROC_SEPARATOR = '->'.freeze
+    TO_H_METHOD_NAME = 'config->to_h'.freeze
+
+    module Base
+      def config
+        @config ||= NamespaceDelegator.new(self)
+      end
+
+      def configure
+        yield(config)
+      end
+
+      def configure!
+        yield(config)
+        config_store.freeze
+      end
+
+      def clone
+        cloned = super
+        cloned_store = config_store.clone
+        cloned.instance_variable_set(:@config_store, cloned_store)
+        cloned.instance_variable_set(:@config, NamespaceDelegator.new(cloned))
+        cloned
+      end
+
+      define_method TO_H_METHOD_NAME do |map = store_map|
+        map.inject({}) do |acc, (k,v)|
+          key = k.to_sym
+          if v.is_a?(Hash)
+            acc[key] = send(TO_H_METHOD_NAME, v)
+          else
+            acc[key] = self.send(v)
+          end
+
+          acc
+        end
+      end
+
+      private
+
+      def config_store
+        @config_store ||= {}
+      end
+
+      def evaluate_config_proc_or_value(value, instance_exec: false)
+        return unless value
+        return value unless value.respond_to?(:call)
+
+        if instance_exec
+          value.arity == 1 ? instance_exec(self, &value) : instance_exec(&value)
+        else
+          value.call
+        end
+      end
+
+      def store_map
+        if is_a?(Class)
+          instance_variable_get(:@store_maps)[:class]
+        else
+          self.class.instance_variable_get(:@store_maps)[:instance]
+        end
+      end
+    end
+  end
+end

data/lib/config_x/interface/builder.rb

@@ -0,0 +1,152 @@
+module ConfigX
+  module Interface
+    class Builder
+      def initialize(config_interface, owner_interface, namespace = [], store_map = {})
+        @config_interface = config_interface
+        @owner_interface = owner_interface
+        @namespace = namespace
+        @store_map = store_map
+      end
+
+      def build(&block)
+        instance_exec(&block)
+        @store_map
+      end
+
+      def attr(name, opts = {}, &block)
+        name = name.to_s
+        validate_attr_name(name)
+
+        if block
+          define_nested_attr_interface(name, opts, &block)
+        else
+          define_attr_interface(name, opts, &block)
+        end
+      end
+
+      private
+
+      def define_attr_interface(name, opts)
+        config_prefixed_namespaced_name = config_prefixed_namespaced_name(name)
+        @store_map[name] = config_prefixed_namespaced_name
+
+        define_getter(
+          @config_interface,
+          name,
+          @namespace,
+          config_prefixed_namespaced_name,
+          opts
+        )
+
+        define_setter(
+          @config_interface,
+          name,
+          @namespace,
+          config_prefixed_namespaced_name
+        )
+
+        return unless opts[:accessor]
+
+        define_getter(
+          @owner_interface,
+          name,
+          @namespace,
+          namespaced_name(name, '_'),
+          opts
+        )
+
+        define_setter(
+          @owner_interface,
+          name,
+          @namespace,
+          namespaced_name(name, '_')
+        )
+      end
+
+      def define_nested_attr_interface(name, opts, &block)
+        config_prefixed_namespaced_name = config_prefixed_namespaced_name(name)
+
+        Builder.new(
+          @config_interface,
+          @owner_interface,
+          @namespace + [name],
+          @store_map[name] ||= {}
+        ).build(&block)
+
+        define_delegator(
+          @config_interface,
+          config_prefixed_namespaced_name,
+          @namespace + [name]
+        )
+
+        return unless opts[:accessor]
+
+        define_delegator(
+          @owner_interface,
+          namespaced_name(name),
+          @namespace + [name]
+        )
+      end
+
+      def validate_attr_name(name)
+        return if name =~ /\A[0-9a-zA-z_]+\z/
+        raise StandardError, "Attribute name #{name} is not allowed. Only [0-9a-zA-z_]+"
+      end
+
+      def define_getter(target, variable_name, namespace, method_name, opts = {})
+        proc_name = "#{variable_name}#{PROC_SEPARATOR}proc"
+
+        target.send :define_method, method_name do |&block|
+          namespaced_config = config_store
+
+          if namespace.any?
+            namespaced_config = namespace.inject(config_store) do |acc, key|
+              acc[key] ||= {}
+            end
+          end
+
+          if block
+            namespaced_config[proc_name] = block
+          elsif namespaced_config[variable_name]
+            namespaced_config[variable_name]
+          elsif value = namespaced_config[proc_name] || opts[:default]
+            value = evaluate_config_proc_or_value(value, instance_exec: opts[:instance_exec])
+            namespaced_config[variable_name] = value if opts[:memoize]
+            value
+          end
+        end
+      end
+
+      def define_setter(target, variable_name, namespace, method_name = variable_name)
+        target.send :define_method, "#{method_name}=" do |value|
+          namespaced_config = config_store
+
+          if namespace.any?
+            namespaced_config = namespace.inject(config_store) do |acc, key|
+              acc[key] ||= {}
+            end
+          end
+          namespaced_config[variable_name] = value
+        end
+      end
+
+      def config_prefixed_namespaced_name(name)
+        ([CONFIG_NAMESPACE] + namespace_for(name)).join(NAMESPACE_SEPARATOR)
+      end
+
+      def namespaced_name(name, separator = NAMESPACE_SEPARATOR)
+        namespace_for(name).join(separator)
+      end
+
+      def namespace_for(name)
+        (@namespace + [name]).compact
+      end
+
+      def define_delegator(target, method_name, namespace)
+        target.send :define_method, method_name do
+          NamespaceDelegator.new(self, namespace)
+        end
+      end
+    end
+  end
+end

data/lib/config_x/namespace_delegator.rb

@@ -0,0 +1,22 @@
+module ConfigX
+  class NamespaceDelegator
+    def initialize(target, namespace = [])
+      @target = target
+      @namespace = namespace
+    end
+
+    attr_accessor :target
+
+    def method_missing(*args, &block)
+      method_name = args.shift
+      target.send(config_prefixed_name(method_name), *args, &block)
+    end
+
+    private
+
+    def config_prefixed_name(name)
+      parts = ([CONFIG_NAMESPACE] + @namespace + [name]).compact
+      parts.join(Interface::NAMESPACE_SEPARATOR)
+    end
+  end
+end

data/lib/config_x/version.rb

@@ -0,0 +1,3 @@
+module ConfigX
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: config_x
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andreas Robecke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-25 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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: ConfigX provides you with a simple DSL to configure classes, modules
+  and objects
+email:
+- andreas@robecke.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config_x.gemspec
+- lib/config_x.rb
+- lib/config_x/interface/base.rb
+- lib/config_x/interface/builder.rb
+- lib/config_x/namespace_delegator.rb
+- lib/config_x/version.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.5.2
+signing_key: 
+specification_version: 4
+summary: A simple DSL to configure classes and objects
+test_files: []