castor 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Guillaume Malette
+
+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,29 @@
+# Castor
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'castor'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install castor
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/castor.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'castor/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "castor"
+  gem.version       = Castor::VERSION
+  gem.authors       = ["Guillaume Malette"]
+  gem.email         = ["gmalette@gmail.com"]
+  gem.description   = %q{Castor is a configuration management gem. It can help write configuration apis for other gems}
+  gem.summary       = %q{Castor is a configuration management gem.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  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 "pry"
+  gem.add_development_dependency "rspec"
+end

data/lib/castor.rb

@@ -0,0 +1,8 @@
+require "castor/version"
+require "castor/configuration"
+
+module Castor
+  def self.configure(&block)
+    Castor::Configuration.new(block)
+  end
+end

data/lib/castor/configuration.rb

@@ -0,0 +1,126 @@
+require 'pry'
+
+module Castor
+  class Configuration
+    def initialize(block)
+      @values = {}
+      instance_eval(&block)
+    end
+
+    def method_missing(name, *args, &block)
+      options = args.last.is_a?(::Hash) ? args.pop : {}
+
+      config_value = nil
+
+      if options[:nested]
+        config_value = Castor::Configuration.new(block)
+
+        selfclass.define_method(name) do 
+          config_value
+        end
+      else
+        block = Proc.new {
+          default (args.first || options.delete(:lazy))
+        } unless block
+
+        config_value = Castor::Configuration::Value.new(name, block)
+
+        selfclass.define_method(name) do
+          config_value.value
+        end
+
+        selfclass.define_method("#{name}=") do |args|
+          config_value.value = args
+        end
+
+        selfclass.define_method("#{name}!") do |arg|
+          config_value
+        end
+      end
+      
+      @values[name] = config_value
+    end
+
+    def call(attributes)
+      attributes.each do |key, value|
+        self.send key, value
+      end
+    end
+
+    def selfclass
+      class << self; self; end;
+    end
+
+
+    class Value
+      def initialize(name, block)
+        @name = name
+        instance_eval(&block)
+        self.value = @default
+      end
+
+      def value=(new_value)
+        if validate!(new_value)
+          @value = new_value
+        end
+      end
+
+      def value
+        lazy? ? lazy_value : @value
+      end
+
+      private 
+
+      def lazy_value
+        v = @value.call
+        validate!(v, true)
+        v
+      end
+
+      def desc(description)
+        @description = description
+      end
+
+      def type(*types)
+        @types = types.flatten
+      end
+
+      def value_in(*values)
+        @possible_values = if values.length == 1 && values.first.is_a?(Enumerable)
+          values.first
+        else
+          values.flatten
+        end
+      end
+
+      def default(default_value = nil, &block)
+        @default = default_value || block
+      end
+
+      def lazy?(lazy_value = nil)
+        lazy_value = lazy_value || @value || @default
+        lazy_value.is_a?(Proc) && !(@types && @types.include?(Proc))
+      end
+
+      def validate!(new_value, jit = false)
+        return true if lazy?(new_value) && !jit
+
+        if (@possible_values && !@possible_values.include?(new_value))
+          raise_validation_error(new_value, "Value must be included in #{@possible_values.to_s}")
+        end
+
+        if (@types && @types.none?{|klass| new_value.is_a?(klass)})
+          raise_validation_error(new_value, "Value must be in types #{@types.to_s}")
+        end
+
+        true
+      end
+
+      def raise_validation_error(new_value, message)
+        raise InvalidValueError.new("Invalid value #{new_value} for #{@name}. #{message}")
+      end
+    end
+
+    class InvalidValueError < RuntimeError; end
+  end
+end

data/lib/castor/version.rb

@@ -0,0 +1,3 @@
+module Castor
+  VERSION = "0.0.1"
+end

data/spec/castor_spec.rb

@@ -0,0 +1,94 @@
+require_relative "spec_helper"
+
+describe Castor do
+  subject {
+    Castor.configure do |config|
+
+      # Complete syntax
+      config.toto do
+        type Integer
+        value_in 1..50
+        default 42
+      end
+
+      # Short syntax
+      config.titi "hello"
+
+      # Mass-assign syntax
+      config.(:mass => :assign, :is => :working, :for => 100)
+      
+      # Nested
+      config.more :nested => true do |nested_config|
+        nested_config.titi :toto
+      end
+
+      # Nested through new Castor
+      config.other_nested Castor.configure{|nested_config|
+        nested_config.is_nested true
+      }
+
+      # Lazy Eval
+      config.time_now :lazy => lambda { Time.now }
+
+      # Lazy eval with block
+      config.lazy_increment do
+        type Fixnum
+        default 3
+      end
+
+      config.proc do
+        type Proc
+        default { 3 }
+      end
+    end
+  }
+  
+  context "default values" do
+    its(:toto) { should == 42 }
+    its(:titi) { should == "hello" }
+    its(:mass) { should == :assign }
+    its(:is)   { should == :working }
+    its(:for)  { should == 100 }
+  end
+
+  context "nested values" do
+    it "sets the correct default values" do
+      subject.more.titi.should == :toto
+      subject.other_nested.is_nested.should be_true
+    end
+  end
+
+  context "lazy values" do
+    it "doesn't override procs" do
+      subject.proc.should be_a Proc
+    end
+  end
+
+  context "changing defaults" do
+    context "normal case" do
+      before {
+        subject.toto = 11
+      }
+
+      its(:toto) { should == 11 }
+    end
+
+    context "lazy eval" do
+      before {
+        i = 0
+        subject.lazy_increment = lambda { i += 1 }
+      }
+
+      it "evaluates the proc" do
+        subject.lazy_increment.should == 1
+        subject.lazy_increment.should == 2
+      end
+    end
+
+    context "to a value out of range" do
+      it "throws an exception" do
+        expect { subject.toto = 100 }.to raise_error Castor::Configuration::InvalidValueError
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,20 @@
+require 'bundler/setup'
+require 'castor'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: castor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Guillaume Malette
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Castor is a configuration management gem. It can help write configuration
+  apis for other gems
+email:
+- gmalette@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- castor.gemspec
+- lib/castor.rb
+- lib/castor/configuration.rb
+- lib/castor/version.rb
+- spec/castor_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Castor is a configuration management gem.
+test_files:
+- spec/castor_spec.rb
+- spec/spec_helper.rb
+has_rdoc: