rescodegen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae7c311ad8954c71748d8e536bc203fd451c7012
+  data.tar.gz: 1411a5c914b880c6ace167e40a56a118f9275ea4
+SHA512:
+  metadata.gz: 5ace15b6e958b8ac72fc89654dccacf2436e98abb52f6e9fce6cdd59a381600fc2b2d0995781524fd3d1fc5786abfe18af747ce9467cc949c425d3c60de41b5f
+  data.tar.gz: af62dbcb88d7180a24ff74cd9c61a793f0925a09f05e5c3d87bef3f352fd66f07d550d711962d5e25dc6bec55a077d70ee1b90a19a30730e9c52d076a367bc6e

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Sean Henry
+
+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,38 @@
+# rescodegen
+A command line tool for creating Swift and Objective-C code from localizable strings.
+## Installation
+`$ sudo gem install rescodegen`
+
+## Usage
+### Generate Code
+`$ rescodegen -l swift -o output_folder Localizable.strings`
+### Options
+
+|Option|Value|Description   |
+|---|---|---|
+|-l|swift\|objc|The language of the generated code|
+|-o|directory|Where to generate the files|
+## Example
+### Localizable.strings  
+
+```
+/* The Ok button label displayed when an error occurs on the home screen. */
+"HomeScreen.Alert.OkButtonLabel" = "Ok";
+
+/* The error message displayed by an alert when content could not be loaded. */
+"HomeScreen.Alert.LoadErrorMessage" = "There was an error loading your content.";
+```
+### Generate Code
+
+```
+$ rescodegen -l swift -o . Localizable.strings
+$ rescodegen -l objc -o . Localizable.strings
+```
+### Xcode
+Drag the generated files into Xcode and add them to your target.
+### Swift
+Access localised strings using the `localizedString` property.
+`Strings.Singular.homeScreen_alert_loadErrorMessage.localizedString`
+### Objective-C
+Access localised strings using the `LocalizedSingularString` function.
+`LocalizedSingularString(SingularStringHomeScreen_alert_loadErrorMessage);`

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+    t.libs << "test"
+    t.libs << "lib"
+    t.test_files = FileList['test/**/*_tests.rb']
+end
+
+task :default => :test

data/bin/rescodegen

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+
+if $PROGRAM_NAME == __FILE__
+  ENV['BUNDLE_GEMFILE'] = File.expand_path('../../Gemfile', __FILE__)
+  require 'rubygems'
+  require 'bundler/setup'
+  $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+end
+
+require 'optparse'
+require 'rescodegen/code_generator/swift_strings_generator'
+require 'rescodegen/code_generator/objc_header_strings_generator'
+require 'rescodegen/code_generator/objc_main_strings_generator'
+require 'rescodegen/key_generator/strings_key_generator'
+require 'rescodegen/code_formatter/swift_code_formatter'
+require 'rescodegen/code_formatter/objc_code_formatter'
+
+options = { output: ".", language: "swift" }
+
+parser = OptionParser.new do |opts|
+    opts.banner = "Usage: rescodegen [options] input_file"
+    opts.separator "Generates some strings"
+    opts.separator "Options:"
+    opts.on("-l", "--language=swift|objc", "swift or objc") do |l|
+        options[:language] = l
+    end
+    opts.on("-o", "--output=directory", "Directory to create file.") do |o|
+        options[:output] = o
+    end
+end
+parser.parse!
+
+abort "Invalid -l argument. Expects swift or objc." if !options[:language].match("swift|objc")
+input_file = ARGV.last
+abort "Missing input_file.\n\n#{parser.help}" if input_file.nil?
+output_file = options[:output] + "/Strings"
+
+def generate_swift_file(code_safe_keys, keys, output_file)
+    formatter = Rescodegen::SwiftCodeFormatter.new
+    code_safe_keys = code_safe_keys.map { |k| formatter.format_string(k) }
+    File.write(output_file + ".swift", Rescodegen::SwiftStringsGenerator.new.generate(code_safe_keys, keys))
+end
+
+def generate_objc_files(code_safe_keys, keys, output_file)
+    formatter = Rescodegen::ObjcCodeFormatter.new
+    code_safe_keys = code_safe_keys.map { |k| formatter.format_string(k) }
+    File.write(output_file + ".h", Rescodegen::ObjcHeaderStringsGenerator.new.generate(code_safe_keys, keys))
+    File.write(output_file + ".m", Rescodegen::ObjcMainStringsGenerator.new.generate(code_safe_keys, keys))
+end
+
+generator = Rescodegen::StringsKeyGenerator.new(File.readlines(input_file))
+keys = generator.keys
+code_safe_keys = generator.code_safe_keys
+generate_swift_file(code_safe_keys, keys, output_file) if options[:language] == "swift"
+generate_objc_files(code_safe_keys, keys, output_file) if options[:language] == "objc"

data/lib/rescodegen/code_formatter/code_formatter.rb

@@ -0,0 +1,11 @@
+
+module Rescodegen
+    class CodeFormatter
+
+    protected
+        def downcase_string_unless_acronym(string)
+            string.downcase! unless string.tr("_", "").size > 1
+            string
+        end
+    end
+end

data/lib/rescodegen/code_formatter/objc_code_formatter.rb

@@ -0,0 +1,11 @@
+require_relative 'code_formatter'
+
+module Rescodegen
+    class ObjcCodeFormatter < CodeFormatter
+
+        def format_string(string)
+            string.sub(/^[a-z]/, &:upcase)
+            .gsub(/_[A-Z]+/) { |s| downcase_string_unless_acronym(s) }
+        end
+    end
+end

data/lib/rescodegen/code_formatter/swift_code_formatter.rb

@@ -0,0 +1,11 @@
+require_relative 'code_formatter'
+
+module Rescodegen
+    class SwiftCodeFormatter < CodeFormatter
+
+        def format_string(string)
+            string.sub(/^[A-Z]+/) { |s| downcase_string_unless_acronym(s) }
+            .gsub(/_[A-Z]+/) { |s| downcase_string_unless_acronym(s) }
+        end
+    end
+end

data/lib/rescodegen/code_generator/objc_header_strings_generator.rb

@@ -0,0 +1,55 @@
+require_relative 'strings_generator'
+
+module Rescodegen
+    class ObjcHeaderStringsGenerator < StringsGenerator
+
+        def generate(keys, values)
+            super(keys, values)
+            import_module("Foundation")
+            .start_enum("SingularString", "NSInteger")
+                .add_cases("SingularString", keys)
+            .finish_enum
+            .add_c_method("NSString*", "LocalizedSingularString", "SingularString", "singularString")
+            .newline
+            @output
+        end
+
+    protected
+
+        def import_module(name)
+            @output += "@import #{name};"
+            newline.newline
+            self
+        end
+
+        def start_enum(name, type)
+            indent
+            @output += "typedef NS_ENUM(#{type}, #{name})"
+            open_brackets
+            self
+        end
+
+        def add_c_method(return_type, name, parameter_type, parameter_name)
+            newline
+            @output += "#{return_type} #{name}(#{parameter_type} #{parameter_name});"
+            self
+        end
+
+        def add_cases(enum_name, keys)
+            keys.each do |key|
+                indent
+                @output += "#{enum_name}#{key},"
+                newline
+            end
+            self
+        end
+
+        def finish_enum
+            decrement_indent_level
+            indent
+            @output += "};"
+            newline
+            self
+        end
+    end
+end

data/lib/rescodegen/code_generator/objc_main_strings_generator.rb

@@ -0,0 +1,88 @@
+require_relative 'strings_generator'
+
+module Rescodegen
+    class ObjcMainStringsGenerator < StringsGenerator
+
+        def generate(keys, values)
+            super(keys, values)
+            newline
+            .import_header("Strings.h")
+            .newline
+            .start_c_method("NSString*", "LocalizedSingularString", "SingularString", "singularString")
+                .start_switch("singularString")
+                    .add_cases(keys.map { |k| "SingularString" + k }, values)
+                .close_brackets
+            .close_brackets
+            .newline
+            @output
+        end
+
+        def import_header(name)
+            @output += "#import \"#{name}\""
+            self
+        end
+
+        def start_c_method(return_type, name, parameter_type, parameter_name)
+            newline
+            @output += "#{return_type} #{name}(#{parameter_type} #{parameter_name})"
+            open_brackets
+            self
+        end
+
+        def start_switch(value)
+            indent
+            @output += "switch (#{value})"
+            open_brackets
+            self
+        end
+
+        def add_cases(keys, values)
+            i = 0
+            until i == keys.size
+                start_case(keys[i], values[i])
+                    .return_value(localized_string(values[i]))
+                .finish_case
+                i += 1
+            end
+            add_default_case
+            self
+        end
+
+        def add_default_case
+            start_default_case
+                .return_value("@\"\"")
+            .finish_case
+        end
+
+        def start_case(key, value)
+            indent
+            @output += "case #{key}:"
+            newline
+            increment_indent_level
+        end
+
+        def start_default_case
+            indent
+            @output += "default:"
+            newline
+            increment_indent_level
+            self
+        end
+
+        def finish_case
+            decrement_indent_level
+            self
+        end
+
+        def return_value(value)
+            indent
+            @output += "return #{value};"
+            newline
+            self
+        end
+
+        def localized_string(value) 
+            return "NSLocalizedString(@\"#{value}\", @\"\")"
+        end
+    end
+end

data/lib/rescodegen/code_generator/strings_generator.rb

@@ -0,0 +1,52 @@
+
+module Rescodegen
+    class StringsGenerator
+
+        def generate(keys, values)
+            raise "Expects keys and values of equal sizes" if keys.size != values.size
+            @output = ""
+            @tab_level = 0
+        end
+
+    protected
+
+        def newline
+            @output += "\n"
+            self
+        end
+
+        def open_brackets
+            @output += " {"
+            newline
+            increment_indent_level
+            self
+        end
+
+        def close_brackets
+            decrement_indent_level
+            indent
+            @output += "}"
+            newline
+            self
+        end
+
+        def increment_indent_level
+            @tab_level += 1
+            self
+        end
+
+        def decrement_indent_level
+            @tab_level -= 1
+            self
+        end
+
+        def indent
+            @output += (1..@tab_level).reduce("") { |a, b| a + tab }
+            self
+        end
+
+        def tab
+            "    "
+        end
+    end
+end

data/lib/rescodegen/code_generator/swift_strings_generator.rb

@@ -0,0 +1,72 @@
+require_relative 'strings_generator'
+
+module Rescodegen
+    class SwiftStringsGenerator < StringsGenerator
+
+        def generate(keys, values)
+            super(keys, values)
+            import_header("Foundation")
+            start_struct("Strings")
+                .start_enum("Singular", "String")
+                    .add_cases(keys, values)
+                    .start_computed_property("localizedString", "String")
+                        .return_localized_string
+                    .close_brackets
+                .close_brackets
+            .close_brackets
+            @output
+        end
+
+    protected
+
+        def newline
+            @output += "\n"
+            self
+        end
+
+        def import_header(name)
+            @output += "import #{name}"
+            newline.newline
+            self
+        end
+
+        def start_struct(name)
+            @output += "struct #{name}"
+            open_brackets
+            newline
+            self
+        end
+
+        def start_enum(name, type)
+            indent
+            @output += "enum #{name}: #{type}"
+            open_brackets
+            self
+        end
+
+        def add_cases(keys, values)
+            ### a.zip(b) -> [ [ a[0], b[0] ], [ a[n], b[n] ] ]
+            keys.zip(values).each do |i| 
+                indent
+                @output += "case #{i[0]} = \"#{i[1]}\""
+                newline 
+            end
+            newline
+            self
+        end
+
+        def start_computed_property(name, type)
+            indent
+            @output += "var #{name}: #{type}"
+            open_brackets
+            self
+        end
+
+        def return_localized_string
+            indent
+            @output += "return NSLocalizedString(rawValue, comment: \"\")"
+            newline
+            self
+        end
+    end
+end

data/lib/rescodegen/key_generator/strings_key_generator.rb

@@ -0,0 +1,33 @@
+
+module Rescodegen
+    class StringsKeyGenerator
+
+        def self.create_from_file(input_file)
+            initialize_from_lines File.readlines(input_file)
+        end
+
+        def initialize(lines)
+            @keys = lines.map { |l| l.encode("UTF-16be", :invalid=>:replace, :replace=>"?").encode('UTF-8') }
+            .reject { |l| l.strip == "" }
+            .select { |l| l[0] == "\"" }
+            .map do |line|
+                line.gsub(/\n$/, "")
+                .gsub(/(")(.*)(" = ".*)/, "\\2") # extracts key from "key" = "description"; format
+            end
+        end
+
+        def keys
+            @keys
+        end
+
+        def code_safe_keys
+            @keys.map do |key|
+                key.gsub(/%\.[0-9]f|%[a-zA-Z@]+/, "_") # replace %d, %ld, %.2f etc
+                .gsub(/[^a-zA-Z0-9]/, "_") # replace unsupported characters 
+                .gsub(/(\s|_)+/, "_") # replaces 1 or more occurance of whitespace and/or '_' with single '_'
+                .gsub(/^_|_$/, "") # remove _ from beginning and end 
+                .gsub(/(^[0-9])/, "_\\1") # add underscore at beginning if starts with number
+            end
+        end
+    end
+end

data/lib/rescodegen/version.rb

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

data/lib/rescodegen.rb

@@ -0,0 +1,5 @@
+require "rescodegen/version"
+
+module Rescodegen
+  # Your code goes here...
+end

data/rescodegen.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rescodegen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rescodegen"
+  spec.version       = Rescodegen::VERSION
+  spec.authors       = ["Sean Henry"]
+  spec.email         = ["hello@seanhenry.codes"]
+
+  spec.summary       = %q{Converts localised string files into Objective-C and Swift code.}
+  spec.homepage      = "https://github.com/seanhenry/rescodegen"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: rescodegen
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sean Henry
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 
+email:
+- hello@seanhenry.codes
+executables:
+- rescodegen
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rescodegen
+- lib/rescodegen.rb
+- lib/rescodegen/code_formatter/code_formatter.rb
+- lib/rescodegen/code_formatter/objc_code_formatter.rb
+- lib/rescodegen/code_formatter/swift_code_formatter.rb
+- lib/rescodegen/code_generator/objc_header_strings_generator.rb
+- lib/rescodegen/code_generator/objc_main_strings_generator.rb
+- lib/rescodegen/code_generator/strings_generator.rb
+- lib/rescodegen/code_generator/swift_strings_generator.rb
+- lib/rescodegen/key_generator/strings_key_generator.rb
+- lib/rescodegen/version.rb
+- rescodegen.gemspec
+homepage: https://github.com/seanhenry/rescodegen
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Converts localised string files into Objective-C and Swift code.
+test_files: []