yaml_strings 0.0.2

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/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jonathan R. Wallace
+
+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 @@
+# YamlStrings
+
+Converts a YAML file, specifically the ones typically used for locale and
+translation files in Rails, to an old style Apple ASCII Property List,
+http://bit.ly/old_style_ascii_property_list
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yaml_strings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yaml_strings
+
+## Usage
+
+    $ rake yaml_strings:yaml_to_strings YAML_FILE=<path_to_file> > your_file_name.strings
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+task :test => :spec
+
+Dir.glob('lib/tasks/*.rake').each { |r| import r }

data/lib/tasks/yaml_strings.rake

@@ -0,0 +1,14 @@
+require "yaml_strings"
+namespace :yaml_strings do
+  desc "Converts a yaml file to a strings format"
+  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)
+
+    yaml_hash = YAML.load(File.open(ENV['YAML_FILE']))
+
+    fail "YAML_FILE is empty" unless yaml_hash
+
+    puts YamlToStringsEncoder.new(yaml_hash).to_s
+  end
+end

data/lib/yaml_strings.rb

@@ -0,0 +1,18 @@
+require "yaml_strings/version"
+require "yaml_strings/yaml_to_strings_encoder"
+require "yaml_strings/strings_to_yaml_encoder"
+require "yaml_strings/load_rake_task"
+
+module YamlStrings
+  class << self
+    def yaml_to_strings(yaml_file)
+      yaml_hash = YAML.load(File.open(yaml_file))
+      YamlToStringsEncoder.new(yaml_hash).to_s
+    end
+
+    def strings_to_yaml(string_file)
+      strings_array = File.readlines(string_file)
+      StringsToYamlEncoder.new(strings_array).to_s
+    end
+  end
+end

data/lib/yaml_strings/load_rake_task.rb

@@ -0,0 +1,9 @@
+# This class ensures that all rake tasks are loaded in a Rails 3 app
+if defined?(Rails)
+  class LoadRakeTask < Rails::Railtie
+    railtie_name :yaml_strings
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), 'tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/yaml_strings/strings_to_yaml_encoder.rb

@@ -0,0 +1,82 @@
+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/lib/yaml_strings/version.rb

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

data/lib/yaml_strings/yaml_to_strings_encoder.rb

@@ -0,0 +1,36 @@
+class YamlToStringsEncoder
+  attr_accessor :yaml_hash
+  def initialize(yaml_hash = {})
+    @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
+  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
+
+  def to_s
+    array = convert_hash_to_dict_property(yaml_hash)
+    to_property_dict_string(array)
+  end
+end

data/spec/lib/strings_to_yaml_encoder_spec.rb

@@ -0,0 +1,123 @@
+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

data/spec/lib/yaml_strings_spec.rb

@@ -0,0 +1,35 @@
+require "spec_helper"
+
+describe YamlStrings, fakefs: true do
+  it "should create a properly formatted, new strings file" do
+    yaml_file   = "sample.yml"
+    File.open(yaml_file, "w") do |f|
+      f.puts("a: ")
+      f.puts("  b: 'c'")
+    end
+
+    subject.yaml_to_strings(yaml_file).should eql(
+<<STRINGS
+{
+"a.b" = "c" ;
+}
+STRINGS
+)
+  end
+
+  it "should convert a strings file to a yaml representation" do
+    strings_file   = "sample.strings"
+    File.open(strings_file, "w") do |f|
+      f.puts("{")
+      f.puts("a.b = 'c';")
+      f.puts("}")
+    end
+
+    subject.strings_to_yaml(strings_file).should eql(
+<<YAML
+a:
+  b: 'c'
+YAML
+)
+  end
+end

data/spec/lib/yaml_to_strings_encoder_spec.rb

@@ -0,0 +1,50 @@
+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
+
+    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
+
+  describe "to_property_dict_string" do
+    it "should handle an empty array" do
+      subject.to_property_dict_string([]).should eql(
+<<STRINGS
+{
+}
+STRINGS
+)
+    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(
+<<STRINGS
+{
+#{dict_property_string}
+}
+STRINGS
+)
+    end
+  end
+
+  describe "to_s" do
+    it "should create a properly formatted 'strings' string" do
+      subject.yaml_hash = { a: { b: :c } }
+      subject.to_s.should eql(
+<<STRINGS
+{
+"a.b" = "c" ;
+}
+STRINGS
+)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'yaml_strings'
+require 'mocha'
+require 'fakefs/spec_helpers'
+
+RSpec.configure do |c|
+  c.mock_with :mocha
+  c.include FakeFS::SpecHelpers, fakefs: true
+end

data/yaml_strings.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/yaml_strings/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jonathan R. Wallace"]
+  gem.email         = ["jonathan.wallace@gmail.com"]
+  gem.description   = %q{Convert YAML files to .string format and vice versa.}
+  gem.summary       = %q{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}
+  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          = "yaml_strings"
+  gem.require_paths = ["lib"]
+  gem.version       = YamlStrings::VERSION
+
+  gem.add_development_dependency 'fakefs'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: yaml_strings
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan R. Wallace
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: &70359630849240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70359630849240
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70359630848140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70359630848140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70359630847180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70359630847180
+description: Convert YAML files to .string format and vice versa.
+email:
+- jonathan.wallace@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- 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/version.rb
+- lib/yaml_strings/yaml_to_strings_encoder.rb
+- spec/lib/strings_to_yaml_encoder_spec.rb
+- spec/lib/yaml_strings_spec.rb
+- spec/lib/yaml_to_strings_encoder_spec.rb
+- spec/spec_helper.rb
+- yaml_strings.gemspec
+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.17
+signing_key: 
+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/yaml_strings_spec.rb
+- spec/lib/yaml_to_strings_encoder_spec.rb
+- spec/spec_helper.rb