seed_formatter 0.0.3 → 0.3.1

data/README.md

@@ -105,3 +105,35 @@ def my_custom_output message, options={}
 end
 ```
 
+## Example: Parsing yaml file
+
+SeedFormatter provides a function for parsing [YAML files](http://www.yaml.org/spec/1.2/spec.html).
+
+The function `load_yaml_file` accepts a single argument `path` that is the path to a .yml file.
+
+`load_yaml_file` also accepts a block that provides an argument `hash` representing the contents of each YAML structure in the .yml file.
+
+For example, a .yml file that has a structure such as:
+
+```YAML
+-
+  something: "Other Thing"
+  ruby: "Programming Language"
+  readme: "Time Consuming"
+```
+
+will yield a hash as such:
+
+```ruby
+{:something => "Other Thing", :ruby => "Programming Language", :readme => "Time Consuming"}
+```
+
+As an example, if you wanted to print the contents of each structure in a .yml file you could call:
+
+```ruby
+load_yaml_file file_path do |hash|
+  puts hash
+end
+```
+
+This will call the block passed through on each structure in the .yml file

data/lib/seed_formatter/version.rb

@@ -1,3 +1,3 @@
 module SeedFormatter
-  VERSION = "0.0.3"
+  VERSION = "0.3.1"
 end

data/lib/seed_formatter.rb

@@ -1,5 +1,6 @@
 require "seed_formatter/version"
 require "colored"
+require "active_support/core_ext/hash/indifferent_access"
 
 module SeedFormatter
   
@@ -51,7 +52,7 @@ module SeedFormatter
     begin
       items = YAML::load(File.read(path))
       items.each do |hash|
-        yield(hash)
+        yield(hash.with_indifferent_access)
       end
     rescue
       error "Unable to load YAML file #{path}, exception: #{$!}"

data/seed_formatter.gemspec

@@ -17,4 +17,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   
   s.add_dependency 'colored'
+  s.add_dependency 'active_support'
 end

data/spec/lib/seed_formatter_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+class TestClass
+  include SeedFormatter
+end
+
+describe SeedFormatter do
+  
+  let(:tc) { TestClass.new }
+  
+  describe '#output' do
+    subject { tc.output message, options }
+    let(:message) { "message" }
+    let(:options) { {} }
+    
+    context 'options[:prefix] is provided' do
+      let(:options) { {:prefix => "a prefix "} }
+      it "prefixes the message with options[:prefix]" do
+        $stdout.should_receive(:puts).with(/a prefix message/)
+        subject
+      end
+    end
+    context 'options[:suffix] is provided' do
+      let(:options) { {:suffix => " a suffix"} }
+      it "suffixes the message with options[:suffix]" do
+        $stdout.should_receive(:puts).with(/message a suffix/)
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:options) { {:color => :blue} }
+      it "prints the message with the provided color" do
+        $stdout.should_receive(:puts).with("\e[34mmessage\e[0m")
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      let(:options) { {:color => nil} }
+      it "prints the message in white by default" do
+        $stdout.should_receive(:puts).with("\e[37mmessage\e[0m")
+        subject
+      end
+    end
+  end
+  
+  describe '#message' do
+    subject { tc.message message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "*** "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :white))
+        subject
+      end
+    end
+  end
+  
+  describe '#success' do
+    subject { tc.success message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "  + "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :green))
+        subject
+      end
+    end
+  end
+  
+  describe '#error' do
+    subject { tc.error message, options }
+    let(:message) { "message" }
+    let(:options) { {:prefix => prefix, :color => color} }
+    let(:prefix)  { nil }
+    let(:color)   { nil }
+    context 'options[:prefix] is provided' do
+      let(:prefix) { "a prefix " }
+      it 'passes options[:prefix] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => prefix))
+        subject
+      end
+    end
+    context 'options[:prefix] is not provided' do
+      it 'passes a default prefix through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:prefix => "  - "))
+        subject
+      end
+    end
+    context 'options[:color] is provided' do
+      let(:color) { :blue }
+      it 'passes options[:color] to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => color))
+        subject
+      end
+    end
+    context 'options[:color] is not provided' do
+      it 'passes a default color through to output' do
+        tc.should_receive(:output).with(anything, hash_including(:color => :red))
+        subject
+      end
+    end
+  end
+  
+  describe '#spacer' do
+    subject { tc.spacer }
+    it 'prints a blank line' do
+      $stdout.should_receive(:puts).with(/^$/)
+      subject
+    end
+  end
+  
+  describe '#load_yaml_file' do
+    context 'valid .yml file' do
+      it 'allows a block to process the contents of each section in the .yml file' do
+        tc.load_yaml_file File.join(Dir.pwd, "spec", "support", "yml", "spec.yml") do |hash|
+          hash["tautology"].should == "tautology"
+        end
+      end
+    end
+    context 'invalid file' do
+      it 'prints out an error' do
+        tc.should_receive(:error)
+        tc.load_yaml_file File.join(Dir.pwd, "spec", "support", "yml", "nothing.yml") do |hash|
+          # Nothing
+        end
+      end
+    end
+  end
+  
+end

data/spec/support/yml/spec.yml

@@ -0,0 +1,10 @@
+-
+  tautology: "tautology"
+-
+  tautology: "tautology"
+-
+  tautology: "tautology"
+-
+  tautology: "tautology"
+-
+  tautology: "tautology"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: seed_formatter
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 17
   prerelease: 
   segments: 
   - 0
-  - 0
   - 3
-  version: 0.0.3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Jordan Maguire
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-03 00:00:00 +08:00
+date: 2012-04-12 00:00:00 +08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,20 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: Easily format the output of your seeds and parse YAML files
 email: 
 - jmaguire@thefrontiergroup.com.au
@@ -51,7 +65,9 @@ files:
 - lib/seed_formatter.rb
 - lib/seed_formatter/version.rb
 - seed_formatter.gemspec
+- spec/lib/seed_formatter_spec.rb
 - spec/spec_helper.rb
+- spec/support/yml/spec.yml
 has_rdoc: true
 homepage: https://github.com/jordanmaguire/seed_formatter
 licenses: []
@@ -87,4 +103,6 @@ signing_key:
 specification_version: 3
 summary: Easily format the output of your seeds and parse YAML files
 test_files: 
+- spec/lib/seed_formatter_spec.rb
 - spec/spec_helper.rb
+- spec/support/yml/spec.yml