apstrings 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b3af4ecc14954ccb8d078fb52ae98475c7722a1
-  data.tar.gz: 312bc33483fdc872f0ecdc8e0fdcb669557549c0
+  metadata.gz: 214c6ebcd43ed72910ca02d269eceb66a9638407
+  data.tar.gz: 2def09e490405096cbb85edbe0ba3d61b8e9ca53
 SHA512:
-  metadata.gz: 4aa46cc5d37810c4415687400f4cc344d95b359d5614f330fb2befea07a9db4c77688d5e18d81aa2397cdec42f8be73e8db9acaff462001ea5ae0b1a2411f8a6
-  data.tar.gz: 8023ddeffd9cd371b6bfc6cd3c3478ff23f526bc0d3443583e65bd7e25c3e4e5c85e47884ba9d5feddd487eb916273c803c98fd5b7bd6a25f4ac4b578a71d584
+  metadata.gz: 74c27433007ed1dfaa1486b58a8a1b2cc0f0300d52538ea5ecef08aff5de2c5f9f408d2e320fa480fb1dd207354e733191268cfdf75471ae99dcae7edb1738bb
+  data.tar.gz: 18643aff518885079e3ed02b2165a6bbeb5711b65e147bd66b1b50fc25db28581e2a71ade167b3794bcaa5a823b84f2a9e2e0dc22bbc1502af2f1897be27d39c

data/bin/apstrings

@@ -1,6 +1,4 @@
 #!/usr/bin/env ruby
-
-require "bundler/setup"
 require "apstrings"
 
 # You can add fixtures and/or initialization code here to make experimenting
@@ -12,8 +10,10 @@ require "apstrings"
 
 
 $ROOT = ARGV[0]
-
+$VALID = true
+$SUMMARYS = []
 Dir::chdir($ROOT)
+Apstrings::log_info("\n----------------\n Entering  #{$ROOT}...")
 files_to_validate = {"master"=> nil,"files" => []}
 Dir.glob(File.join("**", "*.strings")) { |file| 
 	p File.basename(file)
@@ -28,20 +28,22 @@ success = true
 any_file = false
 files_to_validate["files"].each { |file|
 	any_file = true
-	if !Apstrings::validate(file,files_to_validate["master"])
+	$VALID,summary = Apstrings::validate(file,files_to_validate["master"])
+	$SUMMARYS << summary
+	if !$VALID
 		success = false
 	end
  }
 
 if success && any_file
-	Apstrings::log_info("Well done! 🍻 🍻\n")
+	Apstrings::log_info("Validate passed. Well done! 🍻 🍻 \n ----------------")
 	exit(0)
 else if !any_file
-	Apstrings::log_info("Nothing to validate.")
-	exit(0)
-else
-	Apstrings::log_error("Validate failed, See above for details\n")
-	exit(1)
-end
+	Apstrings::log_info("Nothing to validate. \n ----------------")
+		exit(0)
+	else
+		Apstrings::log_error("Validate failed, See above for details.\n ----------------")
+		exit(1)
+	end
 end
  

data/lib/apstrings/dot_string_file.rb

@@ -2,9 +2,10 @@ module Apstrings
   require 'json'
   class DotStringFile
     attr_accessor :kv_pairs
-
-    def initialize
+    attr_accessor :raw_file
+    def initialize(raw_file='')
       @kv_pairs = []
+      @raw_file = raw_file
     end
 
     def key_values

data/lib/apstrings/kv_pair.rb

@@ -8,11 +8,12 @@ module Apstrings
     end
 
     def key
-     line.key.strip unless line.key.nil?
+     line.key unless line.key.nil?
     end
 
     def value
-     line.value.strip unless line.key.nil? 
+     # puts line
+     line.value unless line.key.nil? 
     end
 
     def comment

data/lib/apstrings/line.rb

@@ -6,13 +6,17 @@ module Apstrings
     def initialize(line)
       @content = line
       @in_comment = false
-      raise "ERROR : Line does not end with `;`, #{line}" unless valid?
+      raise "ERROR : Line does not end with `;`, Line => {#{line}}" unless valid?
     end
 
     def empty_line?
       /^\s*$/.match(content) || false
     end
 
+    def slash_comment?
+        content.strip.start_with?("//")
+    end
+
     def whole_comment
       /((^\/\*(.+)\*\/)|(^\/\/(.+)))/.match(content).to_s
     end
@@ -61,12 +65,15 @@ module Apstrings
 
     def value
       if key_value_pair?
-        cleaned_content.partition(/"\s*=\s*"/)[2].gsub!(/(^"|"$)/, "")
+        # puts cleaned_content.partition(/"\s*=\s*"/)[2]
+        # Bugfix : 去掉引号后、冒号前的多余空格
+        # "key" = "value"  ; 
+        cleaned_content.partition(/"\s*=\s*"/)[2].rstrip.gsub!(/(^"|"$)/, "")
       end
     end
 
     def is_comment?
-     whole_comment? || open_comment? || close_comment? || in_comment
+     whole_comment? || open_comment? || close_comment? || in_comment || slash_comment?
     end
   end
 end

data/lib/apstrings/strings_parser.rb

@@ -16,8 +16,9 @@ module Apstrings
             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
+                next if (current_line.empty_line? && current_line.in_comment == false) || !content_line.strip.start_with?("\"")
                 
                 #State machine
                 case state

data/lib/apstrings/strings_validator.rb

@@ -3,13 +3,59 @@ module Apstrings
 	require 'apstrings/strings_parser'
 	require 'apstrings/logger'
 
+	class ValidateResult
+
+		attr_accessor :master_special_character_error
+		attr_accessor :file_special_character_errors
+		attr_accessor :missing_keys
+		attr_accessor :dup_keys
+		attr_accessor :file_format_errors
+		attr_accessor :valid_file_format
+
+
+		def initialize(file,masterFile,
+			file_special_character_errors=[],
+			master_special_character_error=[],
+			missing_keys=[],
+			dup_keys=[],file_format_errors=[],
+			valid_file_format=true)
+
+			@file = file
+			@masterFile = masterFile
+			@file_special_character_errors = file_special_character_errors
+			@master_special_character_error = master_special_character_error
+			@missing_keys = missing_keys
+			@dup_keys = dup_keys
+			@file_format_errors = file_format_errors
+			@valid_file_format = valid_file_format
+		end 
+		
+		def to_hash
+			{   :file=> File.basename(@file), 
+				:masterFile => File.basename(@masterFile), 
+				:master_special_character_error => @master_special_character_error,
+				:file_special_character_errors => @file_special_character_errors , 
+				:missing_keys => @missing_keys , 
+				:dup_keys => @dup_keys,
+				:file_format_errors => @file_format_errors,
+				:valid_file_format => @valid_file_format
+			}
+		end
+	end
+
+
 	class Validator
 
+		class << self; attr_accessor :result end
+
+
 		def self.validate(file,masterFile)
+			@result = ValidateResult.new(file,masterFile);
+			@file = file
 			@master = nil
-             puts "\n-----------------------------------------"
-             puts "apstrings: start validate  strings file : #{file} ..."
-             puts "-----------------------------------------"
+             puts "-----------------------------------------\n\n"
+			 puts "-----------------------------------------"
+             puts "apstrings: start validate  strings file : #{@file} ..."
 			if nil == masterFile
 				Log::warn("No master file provided, validating file format only ...")
 			else
@@ -18,41 +64,57 @@ module Apstrings
 
 			valid_master, valid_file , no_missing_key  = true,true,true
 
-			valid_file = Validator::validate_format(file)
+			begin
+				@string_file = Validator::paredFile(file);
+			rescue Exception => e
+				Log::error(e)
+				@result.valid_file_format = false
+				@result.file_format_errors << e
+				return false,@result.to_hash
+			end
+
+			valid_file = Validator::validate_format(@string_file)
 			if masterFile != nil
-				valid_master = Validator::validate_format(masterFile)
-				no_missing_key = Validator::validate_missing(file,masterFile)
+				valid_master = Validator::validate_format(@master)
+				no_missing_key = Validator::validate_missing(@string_file,@master)
 			end
 			
 			if valid_master && valid_file &&  no_missing_key
 				# Log::info("Yeah! 🍻 🍻 ")
-				return true
+				return true,@result.to_hash
 			else if valid_master && valid_file && !no_missing_key
 #					Log::warn("Missing keys found.")
-					return true
+					return true,@result.to_hash
 				else
 #					Log::error("Invalid file.")
-					return false
+					return false,@result.to_hash
 				end
 			end
 		end
 
-		def self.validate_format(file)
+		def self.validate_format(sf)
 			is_valid = true
 			# puts "apstrings: start validate format for #{file} ..."
-			dup_keys_in_file = Validator::validate_duplicates(file)
-			mismatchs_in_file = Validator::validate_special_characters(file)
+			dup_keys_in_file = Validator::validate_duplicates(sf)
+			mismatchs_in_file = Validator::validate_special_characters(sf)
+			@result.dup_keys = dup_keys_in_file
+			if sf == @master
+				@result.master_special_character_error = @result.master_special_character_error + mismatchs_in_file
+			else
+				@result.file_special_character_errors = @result.file_special_character_errors + mismatchs_in_file
+			end
 			if nil != dup_keys_in_file && !dup_keys_in_file.empty?
-				Log::warn("Dup-keys found in #{file}: \n `#{dup_keys_in_file}`.")
+				Log::warn("Dup-keys found in #{sf.raw_file}: \n `#{dup_keys_in_file}`.")
 			else
 				# Log::info("OK . .")
 			end
 
 			if !mismatchs_in_file.empty?
 				is_valid = false
+				@result.valid_file_format = false
 				mismatchs_in_file.each { |e| e.each_pair {
 						|key,value|
-						Log::error("Mismatch format found in `#{file}`: \n `#{key}` ====>  `#{value}`")
+						Log::error("Mismatch format found in `#{sf.raw_file}`: \n `#{key}` ====>  `#{value}`")
 					}
 				}
 			else
@@ -61,45 +123,47 @@ module Apstrings
 			is_valid
 		end
 
-		def self.validate_missing(file,masterFile)
+		def self.validate_missing(sf,sf_masterFile)
 			# puts "apstrings: checking missing keys for #{file}..."
-			sf = Validator::paredFile(file)
-			sf_masterFile = Validator::paredFile(masterFile)
 			no_missing = true
 			missing_keys = sf_masterFile.keys - sf.keys
+			@result.missing_keys = missing_keys;
 			if !missing_keys.empty?
 				no_missing =false
-				Log::warn("#{missing_keys.count.to_s} missing keys found in #{file} comparing to master file: #{masterFile} : \n #{missing_keys.to_s}")
+				Log::warn("#{missing_keys.count.to_s} missing keys found in #{sf.raw_file} comparing to master file: #{sf_masterFile.raw_file} : \n #{missing_keys.to_s}")
 			else
 				# Log::info("OK...")
 			end
 			no_missing
 		end
 
-		def self.validate_duplicates(file)
+		def self.validate_duplicates(sf)
 			# puts "apstrings: checking dup-keys for #{file}..."
-			sf = Validator::paredFile(file)
 			sf.keys.detect {
 				|e| sf.keys.count(e) > 1
 			}
 		end
 
 
-		def self.validate_special_characters(file)
+		def self.validate_special_characters(sf)
 			# puts "apstrings: checking syntax for #{file}..."
-			sf = Validator::paredFile(file)
 			variables_regex = /%[hlqLztj]?[@%dDuUxXoOfeEgGcCsSpaAF]/
 			mismatchs = []
 			sf.key_values.each {
 				|e|  e.each_pair {
 					|key,value|	
 					fixed_key = Validator::value_in_master(key)	
-					striped_key =  fixed_key.gsub(/%\d\$/,'%') # Strip numbered format placeholders , e.g. %1$@ --> %@ 
-					striped_value = value.gsub(/%\d\$/,'%')   
-					key_variables = striped_key.scan(variables_regex) 
-					value_variables = striped_value.scan(variables_regex) 
-					if !(key_variables.sort == value_variables.sort)
-						mismatchs << {key => value}   
+					if fixed_key != nil
+						striped_key =  fixed_key.gsub(/%\d\$/,'%') # Strip numbered format placeholders , e.g. %1$@ --> %@ 
+						striped_value = value.gsub(/%\d\$/,'%')   
+						key_variables = striped_key.scan(variables_regex) 
+						value_variables = striped_value.scan(variables_regex) 
+						if !(key_variables.sort == value_variables.sort)
+							mismatchs << {key => value}   
+						end
+					else
+						# key in slavor file but does not exist in master file .
+						Log.warn("There is missing key in master file comparing to slavor. As we only check  missing  keys in slavor file, just ignore. \n ");
 					end
 				}
 			}
@@ -107,8 +171,8 @@ module Apstrings
 		end
 
 		def self.paredFile(file)
-			file = Reader.read(file)
-			StringsParser.new(file).parse_file
+			read_file = Reader.read(file)
+			StringsParser.new(read_file,DotStringFile.new(file)).parse_file
 		end
 
 		def self.value_in_master(key)

data/lib/apstrings/version.rb

@@ -1,3 +1,3 @@
 module Apstrings
-  VERSION = "0.3.6"
+  VERSION = "0.3.7"
 end

data/lib/js/formatValidate.js

@@ -0,0 +1,90 @@
+/**
+ *  Formats validate.
+ *
+ *  Example
+ *  var master = 'Amount:  %d  Object: %@ String: %s  Other: %u ';
+ *  var slave = '数值:  %d  OC对象: %@ 字符串: %s  其它: %u ';
+ *  var slave_err = '数值:  %  OC对象: %@ 字符串: %s  其它: %u ';
+ *  var result = validate(master, slave) // true
+ *  var result = validate(master, slave_err) // false
+ *
+ *  Created by Jason Kaer on 6/17/16.
+ *
+ */
+
+/***
+ * Add equals method to Array
+ */
+(function () {
+  if (Array.prototype.equals)
+    console.warn("Overriding existing Array.prototype.equals. Possible causes: New API defines the method, there's a framework conflict or you've got double inclusions in your code.");
+// attach the .equals method to Array's prototype to call it on any array
+  Array.prototype.equals = function (array) {
+    // if the other array is a falsy value, return
+    if (!array)
+      return false;
+
+    // compare lengths - can save a lot of time
+    if (this.length != array.length)
+      return false;
+
+    for (var i = 0, l = this.length; i < l; i++) {
+      // Check if we have nested arrays
+      if (this[i] instanceof Array && array[i] instanceof Array) {
+        // recurse into the nested arrays
+        if (!this[i].equals(array[i]))
+          return false;
+      }
+      else if (this[i] != array[i]) {
+        // Warning - two different object instances will never be equal: {x:20} != {x:20}
+        return false;
+      }
+    }
+    return true;
+  };
+  // Hide method from for-in loops
+  Object.defineProperty(Array.prototype, "equals", {enumerable: false});
+}());
+
+
+/***
+ * Validate formats(i.e. %d %s ...) in slave according to master .
+ * @param master The reference standard string in validate.
+ * @param slave  The string to be validated.
+ * @returns {boolean}
+ */
+function formats_validate(master, slave) {
+  try {
+    var format_m = formats_in_string(master);
+    var format_s = formats_in_string(slave);
+    return format_m.sort().equals(format_s.sort());
+  } catch (err) {
+    console.log(err);
+    return false;
+  }
+}
+
+
+/***
+ * Find all formats in a string
+ * @param input String to scan.
+ * @returns {Array}
+ */
+function formats_in_string(input) {
+
+  var fix_regex = /%\d\$/g ;
+  var scan_regex = /%[hlqLztj]?[@%dDuUxXoOfeEgGcCsSpaAF]/g ;
+
+  //Strip numbered format placeholders , e.g. %1$@ --> %@
+  var fixed_input = input.replace(fix_regex, "%");
+  var m;
+  var result = [];
+  while ((m = scan_regex.exec(fixed_input)) !== null) {
+    if (m.index === scan_regex.lastIndex) {
+      scan_regex.lastIndex++;
+    }
+    result.push(m[0])
+  }
+
+  return result;
+}

data/lib/test.rb

@@ -0,0 +1,6 @@
+require './apstrings.rb'
+
+puts Apstrings.parse('/Users/Jason/Desktop/test.strings').to_json
+
+
+puts "aa : \" ".rstrip

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: apstrings
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - JasonWorking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-03 00:00:00.000000000 Z
+date: 2016-06-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.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'
 - !ruby/object:Gem::Dependency
   name: colored
   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'
 - !ruby/object:Gem::Dependency
   name: json
   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.
@@ -85,22 +85,19 @@ email:
 - 331314708@qq.com
 executables:
 - apstrings
-- console
-- setup
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- apstrings-0.3.7.gem
 - apstrings.gemspec
 - bin/apstrings
-- bin/console
-- bin/setup
 - lib/apstrings.rb
 - lib/apstrings/dot_string_file.rb
 - lib/apstrings/kv_pair.rb
@@ -111,6 +108,8 @@ files:
 - lib/apstrings/strings_validator.rb
 - lib/apstrings/tester.rb
 - lib/apstrings/version.rb
+- lib/js/formatValidate.js
+- lib/test.rb
 homepage: https://github.com/JasonWorking
 licenses:
 - MIT
@@ -121,17 +120,17 @@ 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
+rubygems_version: 2.0.14.1
 signing_key: 
 specification_version: 4
 summary: Apple dot strings file parser.

data/bin/console

@@ -1,14 +0,0 @@
-#!/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

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