activerecord_yamless 0.1.0

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 progress

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem "activesupport" "~> 3.0"
+gem "rails", "~> 3.2"
+
+group :development, :test do
+  gem "rspec-rails", "~> 2.0"
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 menostos
+
+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,31 @@
+# ActiverecordYamless
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'activerecord_yamless'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activerecord_yamless
+
+## Usage
+
+application.rb
+
+    config.database_configuration.base = {
+        adapter: "sqlite3",
+        pool: 5,
+        timeout: 5000
+    }
+
+environments/production.rb
+
+    config.database_configuration.production = {
+      database: "db/production.sqlite3"
+    }

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/activerecord_yamless.gemspec

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/activerecord_yamless/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["menostos"]
+  gem.email         = ["menostos@gmail.com"]
+  gem.description   = %q{This gem removes the need to configuration the database using yaml}
+  gem.summary       = %q{The Gem adds some functionality to the rails configuration allowing users to configure their database within environment files}
+  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.name          = "activerecord_yamless"
+  gem.require_paths = ["lib"]
+  gem.add_development_dependency 'rspec', '~> 2.5'
+  gem.version       = ActiverecordYamless::VERSION
+end

data/lib/activerecord_yamless.rb

@@ -0,0 +1,10 @@
+require 'rails'
+require 'activerecord_yamless/version'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'activerecord_yamless/configuration_extension'
+require 'activerecord_yamless/database_configuration'
+require 'activerecord_yamless/method_name_helper'
+require 'activerecord_yamless/railtie' if defined?(Rails)
+
+module ActiverecordYamless
+end

data/lib/activerecord_yamless/configuration_extension.rb

@@ -0,0 +1,15 @@
+class Rails::Application::Configuration
+
+  # returns the database configuration. if it hasn't been defined
+  # it'll create a new instance of ActiverecordYamless::DatabaseConfiguration.new
+  def database_configuration
+    @database_configuration ||= ActiverecordYamless::DatabaseConfiguration.new
+  end
+
+  # adds an environment configuration to the database configuration.
+  # it'll be merged with the default configuration
+  def database_configuration=(value) 
+    db_config = self.database_configuration
+    db_config.update_with_defaults(Rails.env, value)
+  end
+end

data/lib/activerecord_yamless/database_configuration.rb

@@ -0,0 +1,71 @@
+module ActiverecordYamless
+
+  # the class holds the database configuration
+  class DatabaseConfiguration < HashWithIndifferentAccess
+
+    # get a configuration by key.
+    # if it's not already available, it'll create
+    # the configuration merging the defaults
+    def [](key)
+      if self.include?(key)
+        super
+      else 
+        self.store(key, {}.merge(self.base))
+      end
+    end
+
+    # get the base configuration
+    def base
+      @base ||= HashWithIndifferentAccess.new
+    end
+
+    # assign the base configuration
+    def base=(value)
+      @base = value
+    end
+
+    # updateds the configuration and overwrites all defaults
+    def update_with_defaults(key, value)
+      self.store(key, self.base.merge(value))
+    end
+
+    # returns a configuration by key according to the method name.
+    # it'll define the method for later use
+    def method_missing(method, *args, &block)
+      method_helper = ActiverecordYamless::MethodNameHelper.new(method)
+      if method_helper.setter_method? && args.first && args.first.is_a?(Hash)
+        define_methods_and_assign_value(method_helper, args.first)
+      else
+        super
+      end
+    end
+
+    protected
+    # defines a method accessing a key on self and assigns the given value
+    def define_methods_and_assign_value(method_helper, value)
+      define_read_method!(method_helper)
+      define_write_method!(method_helper)
+      self.send(method_helper.write_method, value)
+    end
+
+    # defines the read method for a key
+    def define_read_method!(method_helper)
+      unless self.respond_to?(method_helper.read_method)
+        define_singleton_method(method_helper.read_method) do
+          return self[method_helper.read_method]
+        end
+      end
+    end
+
+    # defines the write method for a key
+    def define_write_method!(method_helper)
+      unless self.respond_to?(method_helper.write_method)
+        define_singleton_method(method_helper.write_method) do |value|
+          return self[method_helper.read_method] = self.base.merge(value)
+        end
+      end
+    end
+
+  end
+
+end

data/lib/activerecord_yamless/method_name_helper.rb

@@ -0,0 +1,50 @@
+module ActiverecordYamless
+
+
+  class MethodNameHelper
+
+    attr_reader :original_name
+    attr_reader :read_method, :write_method
+
+    # holds methods name computed from name.
+    # provides +original_name+, +read_method+ and +write_method+
+    def initialize(name)
+      @original_name = name.to_s
+      @read_method = MethodNameHelper.extract_method_name(self.original_name)
+      @write_method = MethodNameHelper.setter_name(self.original_name)
+    end
+
+    # returns true if it's already an setter method name
+    def setter_method?
+      MethodNameHelper.setter_method?(self.original_name)
+    end
+
+    class << self
+      # returns true if name is a setter method name
+      def setter_method?(name)
+        name.end_with?("=")
+      end
+
+      # extracts a getter method name
+      def extract_method_name(name)
+        if MethodNameHelper.setter_method?(name)
+          name[0, name.length - 1]
+        else
+          name
+        end
+      end
+
+      # returns a setter method name from name
+      def setter_name(name)
+        if MethodNameHelper.setter_method?(name)
+          name
+        else
+          "#{name}="
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/activerecord_yamless/railtie.rb

@@ -0,0 +1,9 @@
+module ActiverecordYamless
+  class Railtie < Rails::Railtie
+    railtie_name :activerecord_yamless
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), '../..','tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/activerecord_yamless/version.rb

@@ -0,0 +1,3 @@
+module ActiverecordYamless
+  VERSION = "0.1.0"
+end

data/spec/configuration_extension_spec.rb

@@ -0,0 +1,12 @@
+
+require 'spec_helper'
+require 'helpers/my_application'
+describe Rails::Application::Configuration do
+
+  subject{ Rails.application.config.database_configuration }
+
+  it 'should return an instance of ActiverecordYamless::DatabaseConfiguration' do
+    subject.should be_an_instance_of(ActiverecordYamless::DatabaseConfiguration)
+  end 
+
+end

data/spec/database_configuration_spec.rb

@@ -0,0 +1,73 @@
+
+require 'spec_helper'
+
+describe ActiverecordYamless::DatabaseConfiguration do
+
+  it 'should store a set of options within base' do
+    subject.base = {'name' => 'base_options'}
+    subject.base.should eq({'name' => 'base_options'})
+  end
+
+  it 'should assign a value from a setter method call with a hash' do
+    subject.development = {'user' => 'admin'}
+    subject[:development].should eq({'user' => 'admin'})
+  end
+
+  it 'should assign a value from a setter method and use base as defaults' do
+    subject.base = {'adapter' => 'sql', 'encoding' => 'latin1'}
+    subject.development = {'user' => 'admin', 'encoding' => 'utf8'}
+    subject[:development][:adapter].should eq('sql')
+    subject[:development][:user].should eq('admin')
+    subject[:development][:encoding].should eq('utf8')
+  end
+
+  it 'should create getter and setter when called with a setter method' do
+    subject.should_not respond_to(:development)
+    subject.should_not respond_to(:development=)
+    subject.development = {'user' => 'admin'}
+    subject.should respond_to(:development)
+    subject.should respond_to(:development=)
+    subject.development.should eq({'user' => 'admin'})
+  end
+
+  it 'should define a read method by name' do
+    method_helper = ActiverecordYamless::MethodNameHelper.new(:username)
+    subject.should_not respond_to(:username)
+    subject.send(:define_read_method!, method_helper)
+    subject.should respond_to(:username)
+  end
+
+  it 'should read the hash through read method' do
+    method_helper = ActiverecordYamless::MethodNameHelper.new(:name)
+    subject[:name] = 'test'
+    subject.send(:define_read_method!, method_helper)
+    subject.name.should eq('test')
+  end
+
+  it 'should write the hash through write method' do
+    method_helper = ActiverecordYamless::MethodNameHelper.new(:name)
+    subject[:name] = {'firstname' => 'Peter'}
+    subject.send(:define_write_method!, method_helper)
+    subject.name = {'firstname' => 'Sam'}
+    subject[:name][:firstname].should eq('Sam')
+  end
+
+  it 'should define a write method by name' do
+    method_helper = ActiverecordYamless::MethodNameHelper.new(:username)
+    subject.should_not respond_to(:username=)
+    subject.send(:define_write_method!, method_helper)
+    subject.should respond_to(:username=)
+  end
+
+  it 'should define read and write methods and assign a value' do
+    method_helper = ActiverecordYamless::MethodNameHelper.new(:username)
+    subject.should_not respond_to(:username)
+    subject.should_not respond_to(:username=)
+    subject.send(:define_methods_and_assign_value, method_helper, {'default' => true})
+    subject.should respond_to(:username)
+    subject.should respond_to(:username=)
+    subject[:username].include?(:default).should be_true
+    subject[:username][:default].should be_true
+  end
+
+end  

data/spec/helpers/my_application.rb

@@ -0,0 +1,10 @@
+module MyApplication
+  class Application < Rails::Application
+
+    config.database_configuration.base = {
+      database: 'the_database',
+      username: 'the_username',
+    }
+
+  end
+end

data/spec/method_name_helper_spec.rb

@@ -0,0 +1,42 @@
+
+require 'spec_helper'
+
+describe ActiverecordYamless::MethodNameHelper do
+
+  context "when initialized with a write method" do
+  
+    subject{ ActiverecordYamless::MethodNameHelper.new(:name=) }
+
+    it 'should return true for setter_method?' do
+      subject.setter_method?.should be_true
+    end
+
+    it 'should return the correct read method name' do
+      subject.read_method.should eq('name')
+    end
+
+    it 'should return the correct write method name' do
+      subject.write_method.should eq('name=')
+    end
+
+  end
+
+  context "when initialized with a read method" do
+  
+    subject{ ActiverecordYamless::MethodNameHelper.new(:name) }
+
+    it 'should return false for setter_method?' do
+      subject.setter_method?.should be_false
+    end
+
+    it 'should return the correct read method name' do
+      subject.read_method.should eq('name')
+    end
+
+    it 'should return the correct write method name' do
+      subject.write_method.should eq('name=')
+    end
+
+  end
+
+end  

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'activerecord_yamless'
+
+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
+
+  config.order = 'random'
+end

data/tasks/database_extend.rake

@@ -0,0 +1,9 @@
+# loading all environment files which should contain the database configuration
+namespace :db do
+  task :load_env_files do
+    require Rails.root.join("config/application.rb")
+    Dir[Rails.root.join("config/environments/*.rb")].each{|file| require(file) }
+  end
+end
+
+Rake::Task["db:load_config"].prerequisites << :load_env_files

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: activerecord_yamless
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- menostos
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: This gem removes the need to configuration the database using yaml
+email:
+- menostos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- activerecord_yamless.gemspec
+- lib/activerecord_yamless.rb
+- lib/activerecord_yamless/configuration_extension.rb
+- lib/activerecord_yamless/database_configuration.rb
+- lib/activerecord_yamless/method_name_helper.rb
+- lib/activerecord_yamless/railtie.rb
+- lib/activerecord_yamless/version.rb
+- spec/configuration_extension_spec.rb
+- spec/database_configuration_spec.rb
+- spec/helpers/my_application.rb
+- spec/method_name_helper_spec.rb
+- spec/spec_helper.rb
+- tasks/database_extend.rake
+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: The Gem adds some functionality to the rails configuration allowing users
+  to configure their database within environment files
+test_files:
+- spec/configuration_extension_spec.rb
+- spec/database_configuration_spec.rb
+- spec/helpers/my_application.rb
+- spec/method_name_helper_spec.rb
+- spec/spec_helper.rb