config_yml 0.0.2 → 0.0.4

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTFhOTViODNiZTBlYTIzMTkzZGExMzBjZDIxMzc1ZjQzYjk3OWNmYQ==
+  data.tar.gz: !binary |-
+    ZmI0YjUxNDI3OWI5ZTgxZjc1MGZkOGRkNDdkMTJkMzExMmMyZTc5ZA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZDgzNmRhZDk1YTE4NGY0MjA1MjgwOGU4NjE1MzM0NTg5YzgwMzM4MTJjM2Mx
+    YWQ5OTdmODE5MmYzZGEzODRlMzUyZTEzNmIzOTM4Y2ViYjIzZDg5YzU4ODdi
+    NWY4NGQ1ZTliZDFhYWE1Mzk3NzA0MjY5NmM5MTJkYmIzOWNlOTA=
+  data.tar.gz: !binary |-
+    NDY3ZDBiYjVjNjBiMjk3NzUwNWZmODc4YzE4NjUxYTFkMzg3NTUzMDZlMTY4
+    MjM1ZWFlOTI0ZmZlOWEyMjc3ZTczM2IyMjQ2NjRhMWQ5M2IzZDlmZjgxYzFm
+    OTU1NWNjOWRjM2M2Y2MwOGQ5ZmY4ZTc0YjBkMGM2ZTI1ZGI4OGI=

data/.gitignore

@@ -15,3 +15,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store
+config/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    config_yml (0.0.1)
+    config_yml (0.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -12,21 +12,25 @@ Installation
 ------------
 
 If you are using Bundler, add the following code to your Gemfile:
+
 ```ruby
 gem "config_yml", :require => "configuration"
 ```
 
 and run:
+
 ```console
 $ bundle install
 ```
 
 If you are not using Bundler:
+
 ```console
 $ gem install config_yml
 ```
 
 then in your Ruby code:
+
 ```ruby
 require "configuration"
 ```
@@ -39,7 +43,7 @@ Examples
 password: foo
 host: localhost
 port: 6379
-database: bar
+database: 1
 ```
 
 ```ruby
@@ -48,10 +52,11 @@ if redis = Configuration.redis
   ENV["REDIS_URL"] = %(redis://#{password}#{redis[:host]}:#{redis[:port]}/#{redis[:database]})
 end
 
-ENV["REDIS_URL"] # => "redis://:foo@localhost:6379/bar"
+ENV["REDIS_URL"] # => "redis://:foo@localhost:6379/1"
 ```
 
 You can also use the shorthand:
+
 ```ruby
 redis = Conf.redis
 ```
@@ -78,12 +83,14 @@ test:
 ```
 
 Rack
+
 ```ruby
 ENV["RACK_ENV"] # => "development"
 Configuration.mysql[:database] # => "myapp_development"
 ```
 
 Rails
+
 ```ruby
 Rails.env # => "test"
 Configuration.mysql[:database] # => "myapp_test"

data/Rakefile

@@ -1 +1,4 @@
+$:.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
 require "bundler/gem_tasks"
+require "configuration/tasks"

data/lib/configuration/railtie.rb

@@ -0,0 +1,7 @@
+module Configuration
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "configuration/tasks.rb"
+    end
+  end
+end

data/lib/configuration/syntax/conf.rb

@@ -1,5 +1,15 @@
 module Configuration
   module Syntax
+    # Provides a shorthand for access config files
+    #
+    # For example:
+    #
+    #   # The following code
+    #   Conf.foo
+    #
+    #   # is the same as:
+    #   Configuration.foo
+    #
     module Conf
       def self.method_missing(method, *args)
         Configuration.method_missing(method, args)

data/lib/configuration/tasks/generate.rb

@@ -0,0 +1,85 @@
+module Configuration
+  module Tasks
+    # Provides a method to generate yaml files from sample or example files.
+    # This module and methods are intended to use with a rake task and are not
+    # available for the rest of application.
+    #
+    # Examples:
+    #
+    #   # The following files
+    #   config/application.yml.sample
+    #   config/database.yml.sample
+    #   config/resque.yml.example
+    #
+    #   # will generate:
+    #   config/application.yml
+    #   config/database.yml
+    #   config/resque.yml
+    #
+    # If the .yml file already exists and has the same content of the related
+    # .sample file, the .yml will remain untouched. Otherwise, user will be
+    # asked whether the content will be replaced or not.
+    #
+    module Generate
+      class << self
+        def generate_ymls
+          grouped_files.each do |group, files|
+            sample = files.find { |file| file =~ /\.yml\.(s|ex)ample$/ }
+            destination = files.find { |file| file =~ /\.yml$/ }
+
+            begin
+              case files.count
+              when 1
+                generate(sample)
+              when 2
+                replace(sample, destination)
+              else
+                raise
+              end
+            rescue
+              handle_error(group)
+            end
+          end
+        end
+
+        def grouped_files
+          @grouped_files ||= Dir.glob("config/*.yml*").group_by do |file|
+            file.match(/((config\/)([^.]*))/i)[3]
+          end
+        end
+
+        private
+
+        def generate(sample)
+          if sample =~ /\.(s|ex)ample$/
+            destination = sample.sub(/\.(s|ex)ample/, '')
+            FileUtils.cp(sample, destination)
+            puts "#{destination} generated from #{sample}"
+          end
+        end
+
+        def replace(sample, destination)
+          if read_content(sample) != read_content(destination)
+            ask "Do you want to replace existing #{destination}?" do
+              FileUtils.cp(sample, destination)
+              puts "#{destination} content have been replaced by #{sample} content"
+            end
+          end
+        end
+
+        def read_content(file)
+          File.open(file, 'r').readlines
+        end
+
+        def handle_error(group)
+          puts "An error ocurred when trying to copy config/#{group}.* files."
+        end
+
+        def ask(message, &block)
+          print "#{message} (yes/no): "
+          yield if %w{y yes}.include? STDIN.gets.strip
+        end
+      end
+    end
+  end
+end

data/lib/configuration/tasks.rb

@@ -0,0 +1,8 @@
+require "configuration/tasks/generate"
+
+namespace :config_yml do
+  desc "Generate .yml files copying from .yml.sample or .yml.example files."
+  task :generate do
+    Configuration::Tasks::Generate.generate_ymls
+  end
+end

data/lib/configuration/version.rb

@@ -1,3 +1,3 @@
 module Configuration
-  VERSION = "0.0.2".freeze
+  VERSION = "0.0.4".freeze
 end

data/lib/configuration.rb

@@ -1,6 +1,7 @@
 require "yaml"
 
 require "configuration/syntax"
+require "configuration/railtie" if defined?(Rails)
 require "configuration/version"
 
 module Configuration

data/spec/lib/configuration/tasks/generate_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe Configuration::Tasks::Generate do
+  before do
+    Dir.stub(:glob).and_return(files)
+    subject.instance_variable_set(:@grouped_files, nil)
+  end
+
+  describe ".generate_ymls" do
+    before { subject.stub(:puts) }
+    after { files = nil }
+
+    context "when there is only a sample for a foo file" do
+      let(:files) { [sample_file] }
+      let(:sample_file) { "config/foo.yml.sample" }
+      let(:destination_file) { "config/foo.yml" }
+      let(:friendly_message) { "#{destination_file} generated from #{sample_file}" }
+
+      it "generates an yaml file from sample" do
+        FileUtils.should_receive(:cp).with(sample_file, destination_file)
+        subject.generate_ymls
+      end
+
+      it "outputs a friendly message" do
+        subject.should_receive(:puts).with(friendly_message)
+        subject.generate_ymls
+      end
+    end
+
+    context "when there is an yaml and a sample for a foo file" do
+      let(:files) { [destination_file, sample_file] }
+      let(:sample_file) { "config/foo.yml.sample" }
+      let(:destination_file) { "config/foo.yml" }
+      let(:friendly_message) { "#{destination_file} content have been replaced by #{sample_file} content" }
+
+      context "when destination_file content is distinct from sample_file" do
+        before do
+          subject.should_receive(:read_content).with(sample_file).and_return("bar")
+          subject.should_receive(:read_content).with(destination_file).and_return("baz")
+          subject.should_receive(:ask).and_yield
+        end
+
+        it "replaces yaml file with sample" do
+          FileUtils.should_receive(:cp).with(sample_file, destination_file)
+          subject.generate_ymls
+        end
+
+        it "outputs a friendly message" do
+          subject.should_receive(:puts).with(friendly_message)
+          subject.generate_ymls
+        end
+      end
+
+      context "when destination_file content is the same of sample_file" do
+        before { subject.stub(:read_content).and_return("bar") }
+
+        it "doesn't replace yaml file with sample" do
+          FileUtils.should_not_receive(:cp)
+          subject.generate_ymls
+        end
+
+        it "doesn't output a friendly message" do
+          subject.should_not_receive(:puts)
+          subject.generate_ymls
+        end
+      end
+    end
+
+    context "when there is another kind for a foo file" do
+      let(:files) { [sample_file, other_file] }
+      let(:sample_file) { "config/foo.yml.sample" }
+      let(:other_file) { "config/foo.yml.other" }
+      let(:error_message) { "An error ocurred when trying to copy config/foo.* files." }
+
+      it "doesn't generate an yaml file from sample" do
+        FileUtils.should_not_receive(:cp)
+        subject.generate_ymls
+      end
+
+      it "outputs an error message" do
+        subject.should_receive(:puts).with(error_message)
+        subject.generate_ymls
+      end
+    end
+  end
+
+  describe ".grouped_files" do
+    let(:files) { files_a + files_b }
+    let(:files_a) { ["config/file_a.yml", "config/file_a.yml.sample"] }
+    let(:files_b) { ["config/file_b.yml", "config/file_b.yml.sample"] }
+
+    it "returns a list of files grouped by file name" do
+      subject.grouped_files["file_a"].should be_eql files_a
+      subject.grouped_files["file_b"].should be_eql files_b
+    end
+  end
+end

data/spec/lib/configuration_spec.rb

@@ -4,7 +4,7 @@ describe Configuration do
   let(:files) { ["config/file_a.yml", "config/file_b.yml"] }
 
   before do
-    Configuration.instance_variable_set(:@hash, nil)
+    subject.instance_variable_set(:@hash, nil)
     Dir.stub(:glob).and_return(files)
     YAML.stub(:load_file).and_return(file_a, file_b)
   end
@@ -14,7 +14,7 @@ describe Configuration do
     let(:file_b) { double }
 
     it "loads all config files" do
-      Configuration.files.should be_eql files
+      subject.files.should be_eql files
     end
   end
 
@@ -24,14 +24,14 @@ describe Configuration do
     let(:rack_env) { "rack_test" }
     let(:rails_env) { "rails_test" }
 
-    before { Configuration.instance_variable_set(:@env, nil) }
+    before { subject.instance_variable_set(:@env, nil) }
 
     context "when Rack application" do
       before { ENV["RACK_ENV"] = rack_env }
       after { ENV["RACK_ENV"] = nil }
 
       it "returns the environment as symbol" do
-        Configuration.env.should be_eql rack_env.to_sym
+        subject.env.should be_eql rack_env.to_sym
       end
     end
 
@@ -44,13 +44,13 @@ describe Configuration do
       after { Object.send(:remove_const, :Rails) }
 
       it "returns the environment as symbol" do
-        Configuration.env.should be_eql rails_env.to_sym
+        subject.env.should be_eql rails_env.to_sym
       end
     end
 
     context "when environment isn't defined" do
       it "returns nil" do
-        Configuration.env.should be_nil
+        subject.env.should be_nil
       end
     end
   end
@@ -61,8 +61,8 @@ describe Configuration do
       let(:file_b) { { key_b: "value_b" } }
 
       it "responds to keys split in different files" do
-        Configuration.file_a[:key_a].should be_eql "value_a"
-        Configuration.file_b[:key_b].should be_eql "value_b"
+        subject.file_a[:key_a].should be_eql "value_a"
+        subject.file_b[:key_b].should be_eql "value_b"
       end
     end
 
@@ -71,7 +71,7 @@ describe Configuration do
       let(:file_b) { double }
 
       it "responds to nested key values" do
-        Configuration.file_a[:nested][:key].should be_eql "value"
+        subject.file_a[:nested][:key].should be_eql "value"
       end
     end
 
@@ -86,11 +86,11 @@ describe Configuration do
       after { ENV["RACK_ENV"] = nil }
 
       it "returns hash of environment key" do
-        Configuration.file_a[:key].should be_eql "value_test"
+        subject.file_a[:key].should be_eql "value_test"
       end
 
       it "doesn't load hash of other environments" do
-        Configuration.file_a[:key].should_not be_eql "value_dev"
+        subject.file_a[:key].should_not be_eql "value_dev"
       end
     end
 
@@ -99,7 +99,7 @@ describe Configuration do
       let(:file_b) { double }
 
       it "returns nil" do
-        Configuration.foo.should be_nil
+        subject.foo.should be_nil
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require "configuration"
+require "configuration/tasks/generate"
 
 RSpec.configure do |config|
   config.color_enabled = true

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_yml
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.4
 platform: ruby
 authors:
 - Vitor Kiyoshi Arimitsu
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-30 00:00:00.000000000 Z
+date: 2013-05-10 00:00:00.000000000 Z
 dependencies: []
 description: A very simple way of configure your ruby applications through yaml files.
 email: to@vitork.com
@@ -24,38 +23,42 @@ files:
 - Rakefile
 - config_yml.gemspec
 - lib/configuration.rb
+- lib/configuration/railtie.rb
 - lib/configuration/syntax.rb
 - lib/configuration/syntax/conf.rb
+- lib/configuration/tasks.rb
+- lib/configuration/tasks/generate.rb
 - lib/configuration/version.rb
-- spec/lib/configuration/syntax_spec.rb
+- spec/lib/configuration/syntax/conf_spec.rb
+- spec/lib/configuration/tasks/generate_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/vitork/config_yml
 licenses:
 - MIT
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simplify your app configuration.
 test_files:
-- spec/lib/configuration/syntax_spec.rb
+- spec/lib/configuration/syntax/conf_spec.rb
+- spec/lib/configuration/tasks/generate_spec.rb
 - spec/lib/configuration_spec.rb
 - spec/spec_helper.rb