apstrings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b254fe96c0c7a6649d63b91f3149576422524c70
+  data.tar.gz: e80f20ebe76cffd2c692cf95aca6540bf4f1f156
+SHA512:
+  metadata.gz: cd106d42a84875e270ca91763c46e7a34a5cb8210de8a7c0cfe46f4aafd93c4c8e887c143a1c48614136e69be2238895e31caf4acf551ac71203e6490382782c
+  data.tar.gz: 95acbc76b7b0bdd8a213d3aeba65d197265c78315786c809da0a67acb916232641a8c366a82c7527b38e2ea2e279594eb83af9fb6b4ef1c9676ec6ea0a4756a1

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 卡迩
+
+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,41 @@
+# Apstrings
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/apstrings`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apstrings'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apstrings
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake true` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/apstrings. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/apstrings.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'apstrings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "apstrings"
+  spec.version       = Apstrings::VERSION
+  spec.authors       = ["JasonWorking"]
+  spec.email         = ["331314708@qq.com"]
+
+  spec.summary       = %q{Apple dot strings file parser.}
+  spec.description   = %q{An easy to use Apple dot strings file parser with encoding handled.}
+  spec.homepage      = "https://github.com/JasonWorking"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "true"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apstrings"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/apstrings/dot_string_file.rb

@@ -0,0 +1,65 @@
+module Apstrings
+  require 'json'
+  class DotStringFile
+    attr_accessor :kv_pairs
+
+    def initialize
+      @kv_pairs = []
+    end
+
+    def key_values
+      kv_pairs.map do |pair|
+        {pair.key => pair.value}
+      end
+    end
+
+    def keys
+      kv_pairs.map do |pair|
+        pair.key
+      end
+    end
+
+    def values
+      kv_pairs.map do |pair|
+        pair.value
+      end
+    end
+
+    def comments(args={})
+      with_keys = args[:with_keys].nil? ? true : args[:with_keys]
+      cleaned_pairs = kv_pairs.map do |pair|
+        pair
+      end
+      with_keys ? build_comment_hash(cleaned_pairs) : cleaned_pairs.map(&:comment)
+    end
+
+    def to_hash(args={})
+      with_comments = args[:with_comments].nil? ? true : args[:with_comments]
+
+      build_hash { |hash, pair|
+      hash_value = with_comments ? { pair.value => pair.comment } : pair.value
+        hash[pair.key] = hash_value
+      }
+    end
+
+    def to_json(args={})
+      self.to_hash(with_comments: args[:with_comments]).to_json
+    end
+
+    private
+
+      def build_comment_hash(kv_pairs)
+        build_hash { |hash, pair|
+          hash[pair.key] = pair.comment
+        }
+      end
+
+      def build_hash(&block)
+        hash = {}
+        kv_pairs.each do |pair|
+          yield hash, pair
+        end
+        hash
+      end
+  end
+end

data/lib/apstrings/kv_pair.rb

@@ -0,0 +1,29 @@
+module Apstrings
+  class KVPair
+    attr_reader :line, :raw_comment
+
+    def initialize(line, comment)
+     @line = line
+     @raw_comment = comment
+    end
+
+    def key
+     line.key.strip unless line.key.nil?
+    end
+
+    def value
+     line.value.strip unless line.key.nil?
+    end
+
+    def comment
+      if raw_comment.nil?
+        @raw_comment = ""
+      else
+        raw_comment.gsub!(/(\/\*)|(\*\/)/,"")
+        raw_comment.gsub!("\n", " ")
+        raw_comment.gsub!(/\s+/, " ")
+        raw_comment.strip
+      end
+    end
+  end
+end

data/lib/apstrings/line.rb

@@ -0,0 +1,72 @@
+module Apstrings
+  class Line
+    attr_reader :content
+    attr_accessor :in_comment
+
+    def initialize(line)
+      @content = line
+      @in_comment = false
+      raise "Line does not end in ;" unless valid?
+    end
+
+    def empty_line?
+      /^\s*$/.match(content) || false
+    end
+
+    def whole_comment
+      /((^\/\*(.+)\*\/)|(^\/\/(.+)))/.match(content).to_s
+    end
+
+    def whole_comment?
+      !(whole_comment.empty?)
+    end
+
+    def open_comment
+      /^\/\*(.+)$/.match(content).to_s
+    end
+
+    def open_comment?
+      !(open_comment.empty?)
+    end
+
+    def close_comment
+      /^(.+)\*\/\s*$/.match(content).to_s
+    end
+
+    def close_comment?
+      !(close_comment.empty?)
+    end
+
+    def key_value_pair?
+      !!(/^\s*"([^"]+)"\s*=/.match(content))
+    end
+
+    def cleaned_content
+      content.gsub(/;\s*$/, "")
+    end
+
+    def valid?
+      if key_value_pair?
+        !!(/;[\s]*$/.match(content))
+      else
+        true
+      end
+    end
+
+    def key
+      if key_value_pair?
+        cleaned_content.partition(/"\s*=\s*"/)[0].gsub!(/(^"|"$)/, "")
+      end
+    end
+
+    def value
+      if key_value_pair?
+        cleaned_content.partition(/"\s*=\s*"/)[2].gsub!(/(^"|"$)/, "")
+      end
+    end
+
+    def is_comment?
+     whole_comment? || open_comment? || close_comment? || in_comment
+    end
+  end
+end

data/lib/apstrings/reader.rb

@@ -0,0 +1,35 @@
+module Apstrings
+  require 'FileUtils'
+  # Class for reading in files and returning an array of its content
+  class Reader
+    # Reads in a file and returns an array consisting of each line of input
+    # cleaned of new line characters
+    def self.read(file)
+      File.open(file, 'r') do |f|
+        str = f.read
+        if str.bytesize >= 3 and str.getbyte(0) == 0xFF and str.getbyte(1) == 0xFE
+            #UTF-16lE
+            encoder = Encoding::Converter.new("UTF-16lE", "UTF-8")
+            str = encoder.convert(str)
+            str = str.byteslice(3, str.bytesize - 3) # 去掉FFFE
+        elsif str.bytesize >= 3 and str.getbyte(0) == 0xFE and str.getbyte(1) == 0xFF
+            #UTF-16bE
+            encoder = Encoding::Converter.new("UTF-16bE", "UTF-8")
+            str = encoder.convert(str)
+            str = str.byteslice(3, str.bytesize - 3) # 去掉FEFF
+        elsif str.bytesize >= 4 and str.getbyte(0) == 0xEF and str.getbyte(1) == 0xBB and str.getbyte(2) == 0xBF
+            #UTF8
+            str = str.byteslice(4, str.bytesize - 4) # 去掉EFBBBF
+        else
+            #ASCII  
+            str = str.force_encoding('UTF-8')
+        end
+        content = str
+        content.each_line.inject([]) do |content_array, line|
+          line.gsub!("\n","")
+          content_array.push(line)
+        end
+      end
+    end
+  end
+end

data/lib/apstrings/strings_parser.rb

@@ -0,0 +1,55 @@
+module Apstrings
+  require 'apstrings/line'
+  require 'apstrings/kv_pair'
+  require 'apstrings/dot_string_file'
+  class StringsParser
+    KEY = "KEY"
+    COMMENT = "COMMENT"
+
+    def initialize(read_file, parsed_file = DotStringFile.new)
+      @read_file = read_file
+      @parsed_file = parsed_file
+    end
+
+    def parse_file
+      state = KEY
+      current_comment = nil
+      comments_for_keys = {}
+      @read_file.each do |content_line|
+        current_line = Line.new(content_line)
+        next if current_line.empty_line? && current_line.in_comment == false
+
+        #State machine 
+        case state
+        when KEY
+          if current_line.whole_comment?
+            unless current_line.whole_comment.strip == 'No comment provided by engineer.'
+              current_comment = current_line.whole_comment
+            end
+          elsif current_line.key_value_pair? && current_comment
+            comments_for_keys[current_line.key] = current_comment
+            current_comment = nil
+          elsif current_line.open_comment?
+            current_comment = current_line.open_comment + "\n"
+            state = COMMENT
+          end
+        when COMMENT
+          if current_line.close_comment?
+            current_comment += current_line.close_comment
+            state = KEY
+          else
+            current_line.in_comment = true
+            current_comment = current_comment + current_line.content + "\n"
+          end
+        end
+
+        unless current_line.is_comment?
+          @parsed_file.kv_pairs << KVPair.new(current_line, comments_for_keys[current_line.key])
+        end
+      end
+
+      raise "Invalid .string file: Unterminated comment" unless state == KEY
+      @parsed_file
+    end
+  end
+end

data/lib/apstrings/version.rb

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

data/lib/apstrings.rb

@@ -0,0 +1,15 @@
+require "apstrings/version"
+
+module Apstrings
+require 'apstrings/reader'
+require 'apstrings/strings_parser'
+  # Public
+  def self.parse(file)
+    file = read(file)
+    StringsParser.new(file).parse_file
+  end
+
+  def self.read(file)
+    Reader.read(file)
+  end
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: apstrings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- JasonWorking
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: 'true'
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An easy to use Apple dot strings file parser with encoding handled.
+email:
+- 331314708@qq.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- apstrings.gemspec
+- bin/console
+- bin/setup
+- lib/apstrings.rb
+- lib/apstrings/dot_string_file.rb
+- lib/apstrings/kv_pair.rb
+- lib/apstrings/line.rb
+- lib/apstrings/reader.rb
+- lib/apstrings/strings_parser.rb
+- lib/apstrings/version.rb
+homepage: https://github.com/JasonWorking
+licenses:
+- MIT
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Apple dot strings file parser.
+test_files: []