iphone_parser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 720614ec125a2d4dcc200607a272dbc0c74c2239
+  data.tar.gz: 6d552ed1e57811e0d694fcb43ab7feb2303b1eb5
+SHA512:
+  metadata.gz: 7b2b431a92b4ed8d5dd43cbe823b386f83f37c9c26f500cad9f9576b2c8968c27810b02f819218b72c6b10b9eeb09153a9e9d06af2bd18fa2561a06d7dd50638
+  data.tar.gz: a5e1fa2e1da38dd879aa8645d4efa0d7527f6fc14d42e846280c1b16cb52e34b271fcb1985f6ac60595dfd563e9b16524e945245d044d3f2ed1fef6aa6cc269a

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.0

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in iphone_parser.gemspec
+gemspec
+
+gem 'treetop'
+gem 'rspec'
+gem 'byebug'

data/README.md

@@ -0,0 +1,37 @@
+# IphoneParser
+
+Parser for iphone resource files - also can create those files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iphone_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iphone_parser
+
+## Usage
+
+Check the spec folder for lots of examples. A real usage would look like this:
+
+    require 'iphone_parser'
+    strings = IphoneParser.parse(File.open("Localizable.strings").read)
+    strings['one label']
+     => { text: 'the text for this label', comment: all comments on top of this string }
+
+
+## Contributing
+
+1. Fork it ( https://github.com/fotanus/iphone-parser/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/iphone_parser.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iphone_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iphone_parser"
+  spec.version       = IphoneParser::VERSION
+  spec.authors       = ["fotanus@gmail.com"]
+  spec.email         = ["Felipe Tanus"]
+  spec.summary       = %q{Parser for iphone resource files}
+  spec.description   = %q{Parse iphone resource files to extract strings, and create a file with the given strings}
+  spec.homepage      = "http://fotanus.com"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "treetop", "~> 1.5"
+end

data/lib/iphone_parser.rb

@@ -0,0 +1,51 @@
+require "treetop"
+require "iphone_parser/version"
+require 'iphone_parser/ast_nodes'
+require 'iphone_parser/grammar'
+require 'iphone_parser/exceptions'
+
+module IphoneParser
+  def self.parse(file_content)
+    @@parser ||= IphoneResourceFileParser.new
+    ast = @@parser.parse(file_content)
+    if ast
+      generate_hash(ast)
+    else
+      @@parser.failure_reason =~ /^(Expected .+) after/m
+      error = "#{$1.gsub("\n", '$NEWLINE')}:" + "\n"
+      error += file_content.lines.to_a[@@parser.failure_line - 1]
+      error += "#{'~' * (@@parser.failure_column - 1)}^"
+      raise ParseError, error
+    end
+  end
+
+  def self.create_resource_file(entries)
+    raise InvalidEntry unless entries.kind_of? Hash
+
+    entries.reduce("") do |out, entry|
+      label = entry[0]
+      text_and_comment = entry[1]
+      raise InvalidEntry unless text_and_comment.kind_of?(Hash)
+      text = text_and_comment[:text]
+
+      raise InvalidEntry if !label.kind_of?(String) || !text.kind_of?(String)
+
+      out += "\"#{label}\"=\"#{text_and_comment[:text]}\";"
+    end
+  end
+
+  private
+
+    def self.generate_hash(ast)
+      ast.elements.delete_if { |node| !node.kind_of? Entry }
+
+      hash_constructor = ast.elements.map do |entry|
+        label = entry.label.text_value[1..-2]
+        text = entry.text.text_value[1..-2]
+        comments = entry.comments.text_value
+        [ label, {text: text, comments: comments} ]
+      end
+
+      Hash[hash_constructor]
+    end
+end

data/lib/iphone_parser/ast_nodes.rb

@@ -0,0 +1,6 @@
+module IphoneParser
+  class Entry < Treetop::Runtime::SyntaxNode ; end
+  class Comment < Treetop::Runtime::SyntaxNode ; end
+  class Label < Treetop::Runtime::SyntaxNode ; end
+  class Text < Treetop::Runtime::SyntaxNode ; end
+end

data/lib/iphone_parser/exceptions.rb

@@ -0,0 +1,8 @@
+module IphoneParser
+  class ParseError < StandardError ; end
+  class InvalidEntry < StandardError
+    def to_s
+      "Should provide a hash like: {'label' => {text: 'text'}}"
+    end
+  end
+end

data/lib/iphone_parser/grammar.treetop

@@ -0,0 +1,46 @@
+#grammar.treetop
+grammar IphoneResourceFile
+  rule entries
+    entry+
+  end
+
+  rule entry 
+    blank comments blank label blank equal blank text blank semicolon blank <IphoneParser::Entry>
+  end
+
+  rule comments
+    ( blank comment blank )* <IphoneParser::Comment>
+  end
+
+  rule comment
+    single_line_comment / multi_line_comment
+  end
+
+  rule single_line_comment
+    '//' ( ![\n] . )* [\n]
+  end
+
+  rule multi_line_comment
+    '/*' ( !'*/' . )* '*/'
+  end
+
+  rule label
+    '"' ( '\"' / !'"' . )* '"' <IphoneParser::Label>
+  end
+
+  rule equal
+    '='
+  end
+
+  rule text
+    '"' ( '\"' / !'"' . )* '"' <IphoneParser::Text>
+  end
+
+  rule semicolon
+    ';' / ''
+  end
+
+  rule blank
+    [ \t\n]*
+  end
+end

data/lib/iphone_parser/parse.rb

@@ -0,0 +1,5 @@
+module IphoneParser
+  def self.parse
+
+  end
+end

data/lib/iphone_parser/version.rb

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

data/spec/lib/iphone_parser_spec.rb

@@ -0,0 +1,131 @@
+require 'spec_helper'
+
+describe IphoneParser do
+  describe "IphoneParser.parse" do
+    it "parse a simple entry" do
+      resource_file = '"label"="text";'
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(1)
+      expect(strings['label'][:text]).to eq('text')
+
+    end
+
+    it "parse single line comments" do
+      resource_file = <<-eof
+        // my comment
+        "label" = "text";
+      eof
+
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(1)
+      expect(strings['label'][:text]).to eq('text')
+      expect(strings['label'][:comments]).to match(/\/\/ my comment\n/)
+    end
+
+    it "parse multi line comments" do
+      resource_file = <<-eof
+      /* my comment */
+      "label" = "text";
+      eof
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(1)
+      expect(strings['label'][:comments]).to match(/\/\* my comment \*\//)
+      expect(strings['label'][:text]).to eq("text")
+    end
+
+    it "parse multiple strings" do
+      resource_file = <<-eof
+      // comment 1
+      "label 1" = "text 1";
+      /* comment 2 */
+      "label 2" = "text 2";
+      eof
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(2)
+      expect(strings['label 1'][:comments]).to match(/\/\/ comment 1\n/)
+      expect(strings['label 1'][:text]).to eq("text 1")
+      expect(strings['label 2'][:comments]).to match(/\/\* comment 2 \*\//)
+      expect(strings['label 2'][:text]).to eq("text 2")
+    end
+
+    it "semicolon is optional" do
+      resource_file = <<-eof
+      // comment 1
+      "label 1" = "text 1"
+      /* comment 2 */
+      "label 2" = "text 2"
+      eof
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(2)
+      expect(strings['label 1'][:comments]).to match(/\/\/ comment 1\n/)
+      expect(strings['label 1'][:text]).to eq("text 1")
+      expect(strings['label 2'][:comments]).to match(/\/\* comment 2 \*\//)
+      expect(strings['label 2'][:text]).to eq("text 2")
+    end
+
+    it "accept escaped quotes" do
+      resource_file = '"\"label\"1\"" = "\"text\"1\"";'
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(1)
+      expect(strings['\"label\"1\"'][:text]).to eq('\"text\"1\"')
+    end
+
+    it "parses two comments for same string" do
+      resource_file = <<-eof
+        /* my comment */
+        // other comment
+        "label1" = "text1";
+        /* second comment */
+        "label2" = "text2";
+      eof
+      strings = IphoneParser.parse(resource_file)
+      expect(strings.count).to eq(2)
+      expect(strings['label1'][:comments]).to match(/\/\* my comment \*\/.*\/\/ other comment/m)
+      expect(strings['label1'][:text]).to eq('text1')
+      expect(strings['label2'][:comments]).to match(/\/\* second comment \*\//)
+      expect(strings['label2'][:text]).to eq('text2')
+    end
+
+    it "raises for invalid format" do
+      resource_file = '"invalid""="format";'
+      expect {
+        strings = IphoneParser.parse(resource_file)
+      }.to raise_error(IphoneParser::ParseError)
+    end
+  end
+
+  describe "IphoneParser.create_resource_file" do
+    it "creates simple file" do
+      strings = {'label' => { text: 'text'} }
+      expected_output = '"label"="text";'
+      expect(IphoneParser.create_resource_file(strings)).to eq(expected_output)
+    end
+
+    it "ignore comments" do
+      strings = { 'label' => {comments: 'something', text: 'text'} }
+      expected_output = '"label"="text";'
+      expect(IphoneParser.create_resource_file(strings)).to eq(expected_output)
+    end
+
+    it 'raises invalid entry if missing text' do
+      strings = { 'label' => {} }
+      expect {
+        IphoneParser.create_resource_file(strings)
+      }.to raise_error(IphoneParser::InvalidEntry)
+    end
+
+    it 'raises invalid entry for random objects as label' do
+      strings = {'l' => { text: 't'}, Object.new => { text: 't' } }
+      expect {
+        IphoneParser.create_resource_file(strings)
+      }.to raise_error(IphoneParser::InvalidEntry)
+    end
+
+    it 'raises invalid entry for random objects as text' do
+      strings = {'l' => { text: 't'}, 'l2' => { text: Object.new } }
+      expect {
+        IphoneParser.create_resource_file(strings)
+      }.to raise_error(IphoneParser::InvalidEntry)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+require 'iphone_parser'
+require 'iphone_parser/exceptions'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: iphone_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- fotanus@gmail.com
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: treetop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: Parse iphone resource files to extract strings, and create a file with
+  the given strings
+email:
+- Felipe Tanus
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- builds/iphone_parser-0.1.0.gem
+- iphone_parser.gemspec
+- lib/iphone_parser.rb
+- lib/iphone_parser/ast_nodes.rb
+- lib/iphone_parser/exceptions.rb
+- lib/iphone_parser/grammar.treetop
+- lib/iphone_parser/parse.rb
+- lib/iphone_parser/version.rb
+- spec/lib/iphone_parser_spec.rb
+- spec/spec_helper.rb
+homepage: http://fotanus.com
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Parser for iphone resource files
+test_files:
+- spec/lib/iphone_parser_spec.rb
+- spec/spec_helper.rb