yaml_strings 0.0.2 → 0.0.3

data/lib/tasks/yaml_strings.rake

@@ -1,6 +1,6 @@
 require "yaml_strings"
 namespace :yaml_strings do
-  desc "Converts a yaml file to a strings format"
+  desc "Converts a yaml file to a strings format and outputs to STDOUT"
   task :yaml_to_strings do
     fail "YAML_FILE must be set"           unless file = ENV['YAML_FILE']
     fail "YAML_FILE must be set to a file" unless File.exist?(file)
@@ -11,4 +11,20 @@ namespace :yaml_strings do
 
     puts YamlToStringsEncoder.new(yaml_hash).to_s
   end
+
+  desc "Converts a strings file to YAML format and outputs YAML_FILE"
+  task :strings_to_yaml do
+    fail "STRINGS_FILE must be set"           unless file = ENV['STRINGS_FILE']
+    fail "STRINGS_FILE must be set to a file" unless File.exist?(file)
+
+    fail "YAML_FILE must be set"           unless file = ENV['YAML_FILE']
+
+    strings_array = IO.readlines(ENV['STRINGS_FILE'])
+
+    fail "#{ENV['STRINGS_FILE']} is empty" if strings_array.empty?
+
+    File.open(ENV['YAML_FILE'], 'w') do |f|
+      f.write(StringsToHashEncoder.new(strings_array).to_hash.to_yaml)
+    end
+  end
 end

data/lib/yaml_strings/strings_to_hash_encoder.rb

@@ -0,0 +1,86 @@
+class InvalidKeyError < StandardError; end
+class InvalidValueError < StandardError; end
+class InvalidTerminatorError < StandardError; end
+
+class StringsToHashEncoder
+  attr_accessor :strings_array
+  def initialize(strings_array = [])
+    @strings_array = strings_array
+  end
+
+  def to_hash
+    StringsToHashEncoder.parse_strings_array(@strings_array)
+  end
+
+  class << self
+    # Returns a hash when given
+    def parse_strings_array(array)
+      raise ArgumentError.new("Invalid strings format: missing '{\\n'") unless /{/.match(array.shift)
+      raise ArgumentError.new("Invalid strings format: missing '}'")    unless /}/.match(array.pop)
+
+      array.inject({}) do |hash,line|
+        key_string, value = parse_strings_key_value(line)
+
+        key_string = remove_quotes(key_string)
+        value      = remove_quotes(value)
+        keys = key_string.split('.') + [value]
+
+        recursive_merge(hash, nested_hash(keys))
+      end
+    end
+
+    # Adapted from http://stackoverflow.com/a/8415328
+    def recursive_merge(a, b)
+      a.merge(b) {|key, a_item, b_item| recursive_merge(a_item, b_item) } 
+    end
+
+    # %{ a b c d } =>
+    #
+    # { a => { b => { c => d } } }
+    #
+    def nested_hash(keys)
+      keys.reverse.inject { |hsh, elem| { elem => hsh } }
+    end
+
+    # Returns true if the value is a valid string NSString
+    #
+    # See http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html#//apple_ref/doc/uid/20001012-BBCBDBJE
+    # for more info
+    def valid_string?(value)
+      (value       =~ /\s*"[^"]*"\s*/ ||
+       value.strip =~ /\A\S+\Z/) &&
+       value.strip != ';'                # handles case where no text in the value
+    end
+
+    # Returns true if the last character of the string, ignoring spaces, is a
+    # semi-colon.
+    def valid_terminator?(value)
+      return false if value.nil? || value == ""
+
+      value.gsub(' ', '')[-1] == ";"
+    end
+
+    def remove_quotes(key_string)
+      key_string = key_string.strip[1..-1] if key_string.strip[0]  == '"'
+      key_string = key_string.strip[0..-2] if key_string.strip[-1] == '"'
+      key_string.strip!
+      key_string
+    end
+
+    # Validates the format
+    def parse_strings_key_value(line)
+      key_string, value = line.split('=')
+
+      key_string.strip!
+      value.strip!
+
+      raise InvalidValueError.new("Invalid strings format: Missing value for line after '=': '#{line}'")     unless valid_string?(value)
+      raise InvalidKeyError.new("Invalid strings format: Missing key for line before '=': '#{line}'")        unless valid_string?(key_string)
+      raise InvalidTerminatorError.new("Invalid strings format: Missing terminator ';' for line: '#{line}'") unless valid_terminator?(value)
+
+      value = value[0..-2] # Removes the ; from the value
+
+      return key_string, value
+    end
+  end
+end

data/lib/yaml_strings/version.rb

@@ -1,3 +1,3 @@
 module YamlStrings
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/lib/yaml_strings/yaml_to_strings_encoder.rb

@@ -4,33 +4,35 @@ class YamlToStringsEncoder
     @yaml_hash = yaml_hash
   end
 
-  # Returns an array of dict properties as strings
-  #
-  # hsh - a hash to convert into the string representation
-  # prev_keys - a string representing the previous keys of enclosing hashes
-  #
-  # Ex: { a: :b } # => "a" = "b";
-  # Ex: { a: { b: :c } } # => "a.b" = "c";
-  def convert_hash_to_dict_property(hsh, prev_keys = nil)
-    result = []
-    hsh.each_pair {|k,v|
-      if v.is_a?(Hash)
-        new_prev_keys  = "#{[prev_keys, k].compact.join('.')}"
-        result        += convert_hash_to_dict_property(v, new_prev_keys)
-      else
-        result        += ["\"#{[prev_keys, k].compact.join('.')}\" = \"#{v}\" ;"]
-      end
-    }
-    result
+  def to_s
+    array = YamlToStringsEncoder.convert_hash_to_dict_property(yaml_hash)
+    YamlToStringsEncoder.to_property_dict_string(array)
   end
 
-  # Returns a string representing an old ASCII style property list
-  def to_property_dict_string(array_of_dict_propertes)
-    (["{"] + array_of_dict_propertes + ["}", nil]).join("\n")
-  end
+  class << self
+    # Returns an array of dict properties as strings
+    #
+    # hsh - a hash to convert into the string representation
+    # prev_keys - a string representing the previous keys of enclosing hashes
+    #
+    # Ex: { a: :b } # => "a" = "b";
+    # Ex: { a: { b: :c } } # => "a.b" = "c";
+    def convert_hash_to_dict_property(hsh, prev_keys = nil)
+      result = []
+      hsh.each_pair {|k,v|
+        if v.is_a?(Hash)
+          new_prev_keys  = "#{[prev_keys, k].compact.join('.')}"
+          result        += convert_hash_to_dict_property(v, new_prev_keys)
+        else
+          result        += ["\"#{[prev_keys, k].compact.join('.')}\" = \"#{v}\" ;"]
+        end
+      }
+      result
+    end
 
-  def to_s
-    array = convert_hash_to_dict_property(yaml_hash)
-    to_property_dict_string(array)
+    # Returns a string representing an old ASCII style property list
+    def to_property_dict_string(array_of_dict_propertes)
+      (["{"] + array_of_dict_propertes + ["}", nil]).join("\n")
+    end
   end
 end

data/lib/yaml_strings.rb

@@ -1,6 +1,6 @@
 require "yaml_strings/version"
 require "yaml_strings/yaml_to_strings_encoder"
-require "yaml_strings/strings_to_yaml_encoder"
+require "yaml_strings/strings_to_hash_encoder"
 require "yaml_strings/load_rake_task"
 
 module YamlStrings
@@ -10,9 +10,9 @@ module YamlStrings
       YamlToStringsEncoder.new(yaml_hash).to_s
     end
 
-    def strings_to_yaml(string_file)
+    def strings_to_hash(string_file)
       strings_array = File.readlines(string_file)
-      StringsToYamlEncoder.new(strings_array).to_s
+      StringsToHashEncoder.new(strings_array).to_hash
     end
   end
 end

data/spec/lib/strings_to_hash_encoder_spec.rb

@@ -0,0 +1,131 @@
+require "spec_helper"
+
+describe StringsToHashEncoder do
+  it "should exist" do
+    lambda { subject.should be_a(StringsToHashEncoder) }.should_not raise_error(Exception)
+  end
+
+  describe "#to_hash" do
+    it "should work" do
+      subject.strings_array = ["{\n", "en.app_name = awesome;", "}"]
+      subject.to_hash.should eql({ "en" => { "app_name" => "awesome" } })
+    end
+
+    it "should work with a more complicated strings file" do
+      subject.strings_array = ["{\n", "en.app_name = awesome;", "en.helpers.create = \"Create Something\";", "}"]
+      subject.to_hash.should eql({ "en" => { "app_name" => "awesome", "helpers" => { "create" => "\"Create Something\"" } } })
+    end
+  end
+
+  describe "class methods" do
+    subject { StringsToHashEncoder }
+
+    describe ".parse_strings_array" do
+      it "should raise an error if missing '{'" do
+        lambda { subject.parse_strings_array(["}"]) }.should raise_error(ArgumentError)
+      end
+
+      it "should raise an error if missing '}'" do
+        lambda { subject.parse_strings_array(["{\n"]) }.should raise_error(ArgumentError)
+      end
+
+      it "should work" do
+        subject.parse_strings_array(
+          ["{\n", "en.app_name = awesome;", "}"]
+        ).should eql({ "en" => { "app_name" => "awesome" } })
+      end
+    end
+
+    describe ".valid_string?" do
+      it "returns true for a quoted string" do
+        subject.valid_string?("\" \"").should be_true
+      end
+
+      it "returns true for another quoted string" do
+        subject.valid_string?("\"Something good here\"").should be_true
+      end
+
+      it "returns true for non-whitespace string" do
+        subject.valid_string?("something_good_here").should be_true
+      end
+
+      it "returns true for non-whitespace string with a terminator" do
+        subject.valid_string?("something_good_here;").should be_true
+      end
+
+      it "returns false for non-quoted space" do
+        subject.valid_string?(" ").should be_false
+      end
+
+      it "returns false for non-quoted string" do
+        subject.valid_string?("something good here").should be_false
+      end
+    end
+
+    describe ".valid_terminator?" do
+      it "returns true if last character is a ;" do
+        subject.valid_terminator?(";").should be_true
+      end
+
+      it "returns true if last character is a ; ignoring spaces" do
+        subject.valid_terminator?("  ;   ").should be_true
+      end
+
+      it "returns false if last character is not a ; ignoring spaces" do
+        subject.valid_terminator?("  ").should be_false
+      end
+
+      it "returns false if last character is not a ;" do
+        subject.valid_terminator?(";a").should be_false
+      end
+    end
+
+    describe ".parse_strings_key_value" do
+      it "should raise an error if there is no value for a line" do
+        lambda { subject.parse_strings_key_value("\"a.b\" = ;") }.should raise_error(InvalidValueError)
+      end
+
+      it "should raise an error if there is value for a line" do
+        lambda { subject.parse_strings_key_value("\"a.b\" = asdf asdf;") }.should raise_error(InvalidValueError)
+      end
+
+      it "should raise an error if there is no key for a line" do
+        lambda { subject.parse_strings_key_value(" = c;") }.should raise_error(InvalidKeyError)
+      end
+
+      it "should raise an error if there is no terminator" do
+        lambda { subject.parse_strings_key_value("a.b = c") }.should raise_error(InvalidTerminatorError)
+      end
+
+      it "should work fine" do
+        key_string, value = subject.parse_strings_key_value("a.b = c;")
+        key_string.should eql("a.b")
+        value.should eql("c")
+      end
+    end
+
+    describe ".remove_quotes" do
+      it "should remove \" from key_string" do
+        subject.remove_quotes('"a.b"').should eql("a.b")
+      end
+
+      it "should do nothing to the string" do
+        subject.remove_quotes('a.b').should eql("a.b")
+      end
+    end
+
+    describe ".nested_hash" do
+      it "handles one element arrays" do
+        subject.nested_hash([:a]).should eql(:a)
+      end
+
+      it "handles two element arrays" do
+        subject.nested_hash([:a, :b]).should eql({a: :b})
+      end
+
+      it "handles three element arrays" do
+        subject.nested_hash([:a, :b, :c]).should eql({a: { b: :c }})
+      end
+    end
+  end
+end

data/spec/lib/yaml_strings_spec.rb

@@ -25,11 +25,6 @@ STRINGS
       f.puts("}")
     end
 
-    subject.strings_to_yaml(strings_file).should eql(
-<<YAML
-a:
-  b: 'c'
-YAML
-)
+    subject.strings_to_hash(strings_file).should eql({"a"=>{"b"=>"'c'"}})
   end
 end

data/spec/lib/yaml_to_strings_encoder_spec.rb

@@ -1,41 +1,45 @@
 require "spec_helper"
 
 describe YamlToStringsEncoder do
-  describe "convert_hash_to_dict_property" do
-    it "converts a simple hash" do
-      result = subject.convert_hash_to_dict_property({ a: :b })
-      result.first.should eql('"a" = "b" ;')
-    end
+  describe "class methods" do
+    subject { YamlToStringsEncoder }
+
+    describe ".convert_hash_to_dict_property" do
+      it "converts a simple hash" do
+        result = subject.convert_hash_to_dict_property({ a: :b })
+        result.first.should eql('"a" = "b" ;')
+      end
 
-    it "converts a nested hash" do
-      result = subject.convert_hash_to_dict_property({ a: { b: :c } })
-      result.first.should eql('"a.b" = "c" ;')
+      it "converts a nested hash" do
+        result = subject.convert_hash_to_dict_property({ a: { b: :c } })
+        result.first.should eql('"a.b" = "c" ;')
+      end
     end
-  end
 
-  describe "to_property_dict_string" do
-    it "should handle an empty array" do
-      subject.to_property_dict_string([]).should eql(
+    describe ".to_property_dict_string" do
+      it "should handle an empty array" do
+        subject.to_property_dict_string([]).should eql(
 <<STRINGS
 {
 }
 STRINGS
-)
-    end
+        )
+      end
 
-    it "should properly format a dict_property" do
-      dict_property_string = '"a.b" = "c"; '
-      subject.to_property_dict_string([dict_property_string]).should eql(
+      it "should properly format a dict_property" do
+        dict_property_string = '"a.b" = "c"; '
+        subject.to_property_dict_string([dict_property_string]).should eql(
 <<STRINGS
 {
 #{dict_property_string}
 }
 STRINGS
-)
+        )
+      end
     end
   end
 
-  describe "to_s" do
+  describe "#to_s" do
     it "should create a properly formatted 'strings' string" do
       subject.yaml_hash = { a: { b: :c } }
       subject.to_s.should eql(
@@ -44,7 +48,7 @@ STRINGS
 "a.b" = "c" ;
 }
 STRINGS
-)
+      )
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yaml_strings
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-03-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70359630849240 !ruby/object:Gem::Requirement
+  requirement: &70219305851880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359630849240
+  version_requirements: *70219305851880
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70359630848140 !ruby/object:Gem::Requirement
+  requirement: &70219305851140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359630848140
+  version_requirements: *70219305851140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70359630847180 !ruby/object:Gem::Requirement
+  requirement: &70219305850180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70359630847180
+  version_requirements: *70219305850180
 description: Convert YAML files to .string format and vice versa.
 email:
 - jonathan.wallace@gmail.com
@@ -59,10 +59,10 @@ files:
 - lib/tasks/yaml_strings.rake
 - lib/yaml_strings.rb
 - lib/yaml_strings/load_rake_task.rb
-- lib/yaml_strings/strings_to_yaml_encoder.rb
+- lib/yaml_strings/strings_to_hash_encoder.rb
 - lib/yaml_strings/version.rb
 - lib/yaml_strings/yaml_to_strings_encoder.rb
-- spec/lib/strings_to_yaml_encoder_spec.rb
+- spec/lib/strings_to_hash_encoder_spec.rb
 - spec/lib/yaml_strings_spec.rb
 - spec/lib/yaml_to_strings_encoder_spec.rb
 - spec/spec_helper.rb
@@ -93,7 +93,7 @@ specification_version: 3
 summary: Converts a YAML file, specifically the ones typically used for locale and
   translations in Rails, to an old style Apple ASCII Property List, http://bit.ly/old_style_ascii_property_list
 test_files:
-- spec/lib/strings_to_yaml_encoder_spec.rb
+- spec/lib/strings_to_hash_encoder_spec.rb
 - spec/lib/yaml_strings_spec.rb
 - spec/lib/yaml_to_strings_encoder_spec.rb
 - spec/spec_helper.rb

data/lib/yaml_strings/strings_to_yaml_encoder.rb

@@ -1,82 +0,0 @@
-class InvalidKeyError < StandardError; end
-class InvalidValueError < StandardError; end
-class InvalidTerminatorError < StandardError; end
-
-class StringsToYamlEncoder
-  attr_accessor :strings_array
-  def initialize(strings_array = [])
-    @strings_array = strings_array
-  end
-
-  def to_s
-    parse_strings_array(@strings_array)
-  end
-
-  # Returns a hash when given
-  def parse_strings_array(array)
-    raise ArgumentError.new("Invalid strings format: missing '{\\n'") unless /{/.match(array.shift)
-    raise ArgumentError.new("Invalid strings format: missing '}'")    unless /}/.match(array.pop)
-
-    array.inject({}) do |hash,line|
-      key_string, value = parse_strings_key_value(line)
-
-      key_string = remove_quotes_from_key_string(key_string)
-      keys = key_string.split('.')
-
-      hash.merge!(nested_hash(keys + [value]))
-    end
-  end
-
-  # %{ a b c d } =>
-  #
-  # { a => { b => { c => d } } }
-  #
-  def nested_hash(keys)
-    first = keys.shift
-    return first if keys.empty? # base case
-
-    hash        = Hash.new
-    hash[first] = nested_hash(keys)
-    hash
-  end
-
-  # Returns true if the value is a valid string NSString
-  #
-  # See http://developer.apple.com/library/mac/#documentation/Cocoa/Conceptual/PropertyLists/OldStylePlists/OldStylePLists.html#//apple_ref/doc/uid/20001012-BBCBDBJE
-  # for more info
-  def valid_string?(value)
-    (value       =~ /\s*"[^"]*"\s*/ ||
-     value.strip =~ /\A\S+\Z/) &&
-     value.strip != ';'                # handles case where no text in the value
-  end
-
-  # Returns true if the last character of the string, ignoring spaces, is a
-  # semi-colon.
-  def valid_terminator?(value)
-    return false if value.nil? || value == ""
-
-    value.gsub(' ', '')[-1] == ";"
-  end
-
-  def remove_quotes_from_key_string(key_string)
-    key_string = key_string.strip[1..-1] if key_string.strip[0]  == '"'
-    key_string = key_string.strip[0..-2] if key_string.strip[-1] == '"'
-    key_string
-  end
-
-  # Validates the format
-  def parse_strings_key_value(line)
-    key_string, value = line.split('=')
-
-    key_string.strip!
-    value.strip!
-
-    raise InvalidValueError.new("Invalid strings format: Missing value for line after '=': '#{line}'")     unless valid_string?(value)
-    raise InvalidKeyError.new("Invalid strings format: Missing key for line before '=': '#{line}'")        unless valid_string?(key_string)
-    raise InvalidTerminatorError.new("Invalid strings format: Missing terminator ';' for line: '#{line}'") unless valid_terminator?(value)
-
-    value = value[0..-2] # Removes the ; from the value
-
-    return key_string, value
-  end
-end

data/spec/lib/strings_to_yaml_encoder_spec.rb

@@ -1,123 +0,0 @@
-require "spec_helper"
-
-describe StringsToYamlEncoder do
-  it "should exist" do
-    lambda { subject.should be_a(StringsToYamlEncoder) }.should_not raise_error(Exception)
-  end
-
-  describe "#to_s" do
-    it "should work" do
-      subject.parse_strings_array(
-        ["{\n", "en.app_name = awesome;", "}"]
-      ).should eql({ "en" => { "app_name" => "awesome" } })
-    end
-  end
-
-  describe "parse_strings_array" do
-    it "should raise an error if missing '{'" do
-      lambda { subject.parse_strings_array(["}"]) }.should raise_error(ArgumentError)
-    end
-
-    it "should raise an error if missing '}'" do
-      lambda { subject.parse_strings_array(["{\n"]) }.should raise_error(ArgumentError)
-    end
-
-    it "should work" do
-      subject.parse_strings_array(
-        ["{\n", "en.app_name = awesome;", "}"]
-      ).should eql({ "en" => { "app_name" => "awesome" } })
-    end
-  end
-
-  describe "valid_string?" do
-    it "returns true for a quoted string" do
-      subject.valid_string?("\" \"").should be_true
-    end
-
-    it "returns true for another quoted string" do
-      subject.valid_string?("\"Something good here\"").should be_true
-    end
-
-    it "returns true for non-whitespace string" do
-      subject.valid_string?("something_good_here").should be_true
-    end
-
-    it "returns true for non-whitespace string with a terminator" do
-      subject.valid_string?("something_good_here;").should be_true
-    end
-
-    it "returns false for non-quoted space" do
-      subject.valid_string?(" ").should be_false
-    end
-
-    it "returns false for non-quoted string" do
-      subject.valid_string?("something good here").should be_false
-    end
-  end
-
-  describe "valid_terminator?" do
-    it "returns true if last character is a ;" do
-      subject.valid_terminator?(";").should be_true
-    end
-
-    it "returns true if last character is a ; ignoring spaces" do
-      subject.valid_terminator?("  ;   ").should be_true
-    end
-
-    it "returns false if last character is not a ; ignoring spaces" do
-      subject.valid_terminator?("  ").should be_false
-    end
-
-    it "returns false if last character is not a ;" do
-      subject.valid_terminator?(";a").should be_false
-    end
-  end
-
-  describe "parse_strings_key_value" do
-    it "should raise an error if there is no value for a line" do
-      lambda { subject.parse_strings_key_value("\"a.b\" = ;") }.should raise_error(InvalidValueError)
-    end
-
-    it "should raise an error if there is value for a line" do
-      lambda { subject.parse_strings_key_value("\"a.b\" = asdf asdf;") }.should raise_error(InvalidValueError)
-    end
-
-    it "should raise an error if there is no key for a line" do
-      lambda { subject.parse_strings_key_value(" = c;") }.should raise_error(InvalidKeyError)
-    end
-
-    it "should raise an error if there is no terminator" do
-      lambda { subject.parse_strings_key_value("a.b = c") }.should raise_error(InvalidTerminatorError)
-    end
-
-    it "should work fine" do
-      key_string, value = subject.parse_strings_key_value("a.b = c;")
-      key_string.should eql("a.b")
-      value.should eql("c")
-    end
-  end
-
-  describe "remove_quotes_from_key_string" do
-    it "should remove \" from key_string" do
-      subject.remove_quotes_from_key_string('"a.b"').should eql("a.b")
-    end
-
-    it "should do nothing to the string" do
-      subject.remove_quotes_from_key_string('a.b').should eql("a.b")
-    end
-  end
-
-  describe "#nested_hash" do
-    it "handles one element arrays" do
-      subject.nested_hash([:a]).should eql(:a)
-    end
-
-    it "handles two element arrays" do
-      subject.nested_hash([:a, :b]).should eql({a: :b})
-    end
-
-    it "handles three element arrays" do
-      subject.nested_hash([:a, :b, :c]).should eql({a: { b: :c }})
-    end
-  end
-end