apstrings 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 292a421cdd4aab71df731888d6a0a68d98ca7aea
-  data.tar.gz: 8e590af7b8e60118de6c8e7e16134145d94ef0c6
+  metadata.gz: 011d080462302bfd646f59aa1507c7eb4239dae7
+  data.tar.gz: 98300de74e2dc328b3e3dfad41d1d85c924af0f5
 SHA512:
-  metadata.gz: 1e2e9fefdb7298f0bfaf47f0a906139705d045318989a49e30721e2829a32bff3a8a0dfd0672ffbf4347981e24b7089cc4939b4471558d06281003c7df4bdcb9
-  data.tar.gz: 63208036355c703c77f6b236b7c2c7fe9bd23b371b2958f015a4d0c23aa13d2b8b792ed8d497633b8d24bf323273a25b21165fbf5f5afdcf3bcccfd6ce874c8f
+  metadata.gz: 11a44096aec13d0ef9e5a7198707628c1f6cab0a3398f1d243faf2182fb9726e5a4d2adda38b5d16d0ef1178f1dee27743765158263a4f45fb4f7cff2893ac9a
+  data.tar.gz: ec3749296763dcd22760cdfc53ca79affaa5fd9e22fc47661a927138dcf19f358ad6da09b163ebed90c3f7ed2bb17683027ea328cd3f6b81bfe32acd741b2ff3

data/README.md

@@ -1,8 +1,17 @@
 # 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.
+An Apple dot strings file parser in ruby. 
+
+Valid input strings file formats :
+
+> ASCII
+> 
+> UTF8
+> 
+> UTF-16lE
+> 
+> UTF-16bE
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +31,15 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```
+	string_file = Apstring.parse('path/to/dotStringFile')
+	
+	string_file.to_hash 
+	
+	string_file.to_json
+	
+	
+```
 
 ## Development
 
@@ -32,7 +49,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/JasonWorking/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

data/lib/apstrings/logger.rb

@@ -0,0 +1,20 @@
+
+module Apstrings
+	require 'colorize'
+	class Log 
+		def self.info(message)
+			puts "INFO : #{message}".green
+		end
+
+		def self.warn(message)
+			puts "WARNING: #{message}".yellow			
+		end
+
+		def self.error(message)
+			puts "ERROR: #{message}".red
+		end
+
+	end
+	
+	
+end

data/lib/apstrings/strings_parser.rb

@@ -1,64 +1,55 @@
 module Apstrings
-  require 'apstrings/line'
-  require 'apstrings/kv_pair'
-  require 'apstrings/dot_string_file'
-  require 'colorize'
-
-  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 = {}
-      idx = 1;
-      @read_file.each do |content_line|
-        begin
-          current_line = Line.new(content_line)
-          next if current_line.empty_line? && current_line.in_comment == false
-        rescue RuntimeError => e
-          puts  "#{e} \b Error occured in #{@read_file}, \n line number : #{idx}.".red
-          else
-            idx ++;
+    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
         
-        #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
+        def parse_file
             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])
+            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
-
-      raise "Invalid .string file: Unterminated comment" unless state == KEY
-      @parsed_file
     end
-  end
 end

data/lib/apstrings/strings_validator.rb

@@ -0,0 +1,104 @@
+module Apstrings
+	require 'apstrings/reader'
+	require 'apstrings/strings_parser'
+	require 'apstrings/logger'
+
+	class Validator
+
+		def self.validate(file,masterFile)
+			puts "apstrings: start validate  strings file  ..."
+			if nil == masterFile
+				Log::warn("No master file provided, validating file format for #{file} only ...")
+			end
+
+			valid_master, valid_file , no_missing_key  = true,true,true
+
+			valid_file = Validator::validate_format(file)
+			if masterFile != nil
+				valid_master = Validator::validate_format(masterFile)
+				no_missing_key = Validator::validate_missing(file,masterFile)
+			end
+			
+			if valid_master && valid_file &&  no_missing_key
+				Log::info("Yeah! 🍻 🍻 ")
+				return true
+			else
+				Log::error("Oh no! Invalid file.")
+				return false
+			end
+		end
+
+		def self.validate_format(file)
+			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)
+			if nil != dup_keys_in_file && !dup_keys_in_file.empty?
+				Log::warn("Dup-keys found in #{file}: \n `#{dup_keys_in_file}`.")
+			else
+				# Log::info("OK . .")
+			end
+
+			if !mismatchs_in_file.empty?
+				is_valid = false
+				mismatchs_in_file.each { |e| e.each_pair {
+						|key,value|
+						Log::error("Mismatch format found in `#{file}`: \n `#{key}` ====>  `#{value}`")
+					}
+				}
+			else
+				# Log::info("OK ...  \n ")
+			end
+			is_valid
+		end
+
+		def self.validate_missing(file,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
+			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}")
+			else
+				# Log::info("OK...")
+			end
+			no_missing
+		end
+
+		def self.validate_duplicates(file)
+			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)
+			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|		
+					striped_value = value.gsub(/%\d\$/,'%')  # Strip numbered format placeholders , e.g. %1$@ --> %@  
+					key_variables = key.scan(variables_regex) 
+					value_variables = striped_value.scan(variables_regex) 
+					if !(key_variables.sort == value_variables.sort)
+						mismatchs << {key => value}   
+					end
+				}
+			}
+			mismatchs
+		end
+
+		def self.paredFile(file)
+			file = Reader.read(file)
+			StringsParser.new(file).parse_file
+		end
+
+	end
+	
+end

data/lib/apstrings/version.rb

@@ -1,3 +1,3 @@
 module Apstrings
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/apstrings.rb

@@ -4,22 +4,22 @@ require 'colorize'
 module Apstrings
 require 'apstrings/reader'
 require 'apstrings/strings_parser'
-  # Public
-  def self.parse(file)
-    file = Apstrings::read(file)
-    StringsParser.new(file).parse_file
-  end
-
-  def self.read(file)
-    Reader.read(file)
-  end
-
-  def self.check(path = File::expand_path("."), master = "zh-Hans")
-  	p "Checking files recursively for #{path} according to master strings file name : #{master}"
-
-
-  end
+require 'apstrings/strings_validator'
 
+  # Public
+	def self.parse(file)
+    	file = Apstrings::read(file)
+		StringsParser.new(file).parse_file
+  	end
+
+	def self.read(file)
+		Reader.read(file)
+	end
+
+  	def self.validate(file,masterFile = nil)
+  		Validator::validate(file,masterFile)
+  	end
+  	
 end
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: apstrings
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - JasonWorking
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-28 00:00:00.000000000 Z
+date: 2015-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,8 +75,10 @@ files:
 - lib/apstrings/dot_string_file.rb
 - lib/apstrings/kv_pair.rb
 - lib/apstrings/line.rb
+- lib/apstrings/logger.rb
 - lib/apstrings/reader.rb
 - lib/apstrings/strings_parser.rb
+- lib/apstrings/strings_validator.rb
 - lib/apstrings/version.rb
 homepage: https://github.com/JasonWorking
 licenses: