Merge pull request #45 from Swinject/rubocop

Rubocop

Author: yoichitgy

.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 2.0
+  Exclude:
+    - '*.podspec'
+    - 'ExampleProject/**/**'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

ExampleProject/CodeGenerationExample/Podfile

@@ -1,9 +1,9 @@
 # Uncomment this line to define a global platform for your project
-platform :ios, '8.0'
+platform :ios, "8.0"
 # Uncomment this line if you're using Swift
 use_frameworks!
 
-target 'CodeGenerationExample' do
+target "CodeGenerationExample" do
   pod "Swinject"
-  pod 'Swinject-CodeGen', :git => 'https://github.com/Swinject/Swinject-CodeGen.git'
+  pod "Swinject-CodeGen", git: "https://github.com/Swinject/Swinject-CodeGen.git"
 end

Gemfile

@@ -4,6 +4,7 @@ source "https://rubygems.org"
 gem "cocoapods", "1.0.0.rc.1"
 gem "fastlane"
 
-require 'rubygems'
-gem 'minitest' # ensures you're using the gem, and not the built in MT
-gem 'minitest-reporters'
+require "rubygems"
+gem "minitest" # ensures you're using the gem, and not the built in MT
+gem "minitest-reporters"
+gem "rubocop"

Gemfile.lock

@@ -9,6 +9,7 @@ GEM
       tzinfo (~> 1.1)
     addressable (2.4.0)
     ansi (1.5.0)
+    ast (2.2.0)
     babosa (1.0.2)
     builder (3.2.2)
     cert (1.4.1)
@@ -196,6 +197,8 @@ GEM
     net-ssh (3.1.1)
     netrc (0.7.8)
     os (0.9.6)
+    parser (2.3.1.0)
+      ast (~> 2.2)
     pem (1.3.0)
       fastlane_core (>= 0.36.1, < 1.0.0)
       spaceship (>= 0.22.0, < 1.0.0)
@@ -205,13 +208,21 @@ GEM
       spaceship (>= 0.24.1, < 1.0.0)
       terminal-table (~> 1.4.5)
     plist (3.1.0)
+    powerpack (0.1.1)
     produce (1.1.2)
       fastlane_core (>= 0.30.0, < 1.0.0)
       spaceship (>= 0.16.0, < 1.0.0)
+    rainbow (2.1.0)
     representable (2.3.0)
       uber (~> 0.0.7)
     retriable (2.1.0)
     rouge (1.10.1)
+    rubocop (0.39.0)
+      parser (>= 2.3.0.7, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.0)
     rubyzip (1.1.7)
     scan (0.6.0)
@@ -263,6 +274,7 @@ GEM
     unf (0.1.4)
       unf_ext
     unf_ext (0.0.7.2)
+    unicode-display_width (1.0.5)
     xcodeproj (1.0.0.rc.1)
       activesupport (>= 3)
       claide (= 1.0.0.rc.1)
@@ -280,6 +292,7 @@ DEPENDENCIES
   fastlane
   minitest
   minitest-reporters
+  rubocop
 
 BUNDLED WITH
    1.12.3

Tests/test.rb

@@ -1,43 +1,47 @@
-require 'minitest/autorun'
-require 'minitest/reporters'
+require "minitest/autorun"
+require "minitest/reporters"
 
 reporter_options = { color: true }
-Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]
+default_reporter = Minitest::Reporters::DefaultReporter.new(reporter_options)
+Minitest::Reporters.use! [default_reporter]
 
+# code generation tests
 class TestCodegeneration < Minitest::Test
-  def buildCSV(fileName)
-    %x(./../bin/swinject_codegen -i #{fileName}).chomp
+  def build_csv(file_name)
+    `./../bin/swinject_codegen -i #{file_name}`.chomp
   end
 
-  def readFile(fileName)
-    File.read(fileName).chomp
+  def read_file(file_name)
+    File.read(file_name).chomp
   end
 
-  def runTest(baseFileName)
-    assert_equal buildCSV("Examples/#{baseFileName}.csv"), readFile("ExpectedCode/#{baseFileName}.swift")
+  def run_test(base_file_name)
+    output = build_csv("Examples/#{base_file_name}.csv")
+    example = read_file("ExpectedCode/#{base_file_name}.swift")
+    assert_equal output, example
   end
 
   def test_example_a
-    runTest("ExampleA")
+    run_test("ExampleA")
   end
 
   def test_example_b
-    runTest("ExampleB")
+    run_test("ExampleB")
   end
 
   def test_example_c
-    runTest("ExampleC")
+    run_test("ExampleC")
   end
 
   def test_example_d
-    runTest("ExampleD")
+    run_test("ExampleD")
   end
 
   def test_example_e
-    runTest("ExampleE")
+    run_test("ExampleE")
   end
 
   def test_example_f
-    runTest("ExampleF")
+    run_test("ExampleF")
   end
 end

bin/swinject_codegen

@@ -2,9 +2,9 @@
 require "erb"
 require "Shellwords"
 require "optparse"
-require_relative "../source/CSVParser"
-require_relative "../source/YMLParser"
-require_relative "../source/YMLSerializer"
+require_relative "../source/csv_parser"
+require_relative "../source/yml_parser"
+require_relative "../source/yml_serializer"
 
 @options = {
   MIGRATION: false,
@@ -50,7 +50,7 @@ def main
     output_filename = @options[:OUTPUT_FILE]
 
     if input_filename.end_with?("csv")
-      YMLSerializer.new.serialize_hash_to_YML(definition_hash, output_filename)
+      YMLSerializer.new.serialize_hash_to_yml(definition_hash, output_filename)
     elsif input_filename.end_with?("yml")
       serialize_hash_to_CSV(definition_hash, output_filename)
     end
@@ -75,9 +75,9 @@ end
 
 def parse_input_file(input_filename)
   if input_filename.end_with?("csv")
-    return CSVParser.new.parse_CSV(input_filename)
+    return CSVParser.new.parse_csv(input_filename)
   elsif input_filename.end_with?("yml")
-    return YMLParser.new.parse_YML(input_filename)
+    return YMLParser.new.parse_yml(input_filename)
   else
     puts "unknown input format for file #{input_filename}"
     exit
@@ -92,17 +92,16 @@ def write_container_file(input_hash, output_filename)
   @content_array = input_hash[:DEFINITIONS]
   @dependencies = input_hash[:DEPENDENCIES]
 
-  code = ERB.new(File.read("#{templates_folder()}/container.erb"), nil, "-").result
+  code = ERB.new(File.read("#{templates_folder}/container.erb"), nil, "-").result
 
   if output_filename.nil?
     puts code
   else
-    File.open(output_filename, 'w') do |file_to_write_to|
+    File.open(output_filename, "w") do |file_to_write_to|
       file_to_write_to.puts code
       puts "Generated code in #{output_filename}"
     end
   end
-
 end
 
 def write_migration_file(input_hash, output_filename)
@@ -112,27 +111,26 @@ def write_migration_file(input_hash, output_filename)
     register_function_call_without_last_comma = definition[:register_function_call].reverse.sub(",", "").reverse
 
     migration_hash = {
-      resolve_function_signature_regex: Shellwords.escape(".#{definition[:resolve_function_signature].split("->").first.strip}"),
+      resolve_function_signature_regex: Shellwords.escape(".#{definition[:resolve_function_signature].split('->').first.strip}"),
       resolve_function_call: Shellwords.escape("#{definition[:resolve_function_call]})!"),
-      register_function_signature_regex: Shellwords.escape(".#{definition[:register_function_signature].split("(").first}"),
+      register_function_signature_regex: Shellwords.escape(".#{definition[:register_function_signature].split('(').first}"),
       register_function_call: Shellwords.escape("#{register_function_call_without_last_comma})")
     }
 
     @migration_array.push migration_hash
   end
 
-  migration_code = ERB.new(File.read("#{templates_folder()}/migration.erb"), nil, "-").result
+  migration_code = ERB.new(File.read("#{templates_folder}/migration.erb"), nil, "-").result
 
   if output_filename.nil?
     puts migration_code
   else
     migration_file_name = "#{output_filename}.migration.sh"
-    File.open(migration_file_name, 'w') do |file_to_write_to|
+    File.open(migration_file_name, "w") do |file_to_write_to|
       file_to_write_to.puts migration_code
       puts "Generated migration code in #{migration_file_name}"
     end
   end
-
 end
 
 def prepare_definitions(hash)
@@ -145,22 +143,22 @@ def prepare_definitions(hash)
     argument_hashes = definition[:arguments]
 
     register_function_signature = "register"
-    register_function_signature << definition[:component].gsub("<", "").gsub(">", "").gsub(".", "")
+    register_function_signature << definition[:component].delete("<").delete(">").delete(".")
     register_function_signature << "_#{name}" unless has_no_name
     register_function_signature << "(registerClosure: (resolver: ResolverType"
-    register_function_signature << ", " unless (argument_hashes.nil? || argument_hashes.empty?)
-    register_function_signature << argument_hashes.map {|a| "#{a[:argument_name]}: #{a[:argument_type]}"}.join(", ") unless (argument_hashes.nil? || argument_hashes.empty?)
+    register_function_signature << ", " unless argument_hashes.nil? || argument_hashes.empty?
+    register_function_signature << argument_hashes.map { |a| "#{a[:argument_name]}: #{a[:argument_type]}" }.join(", ") unless argument_hashes.nil? || argument_hashes.empty?
     register_function_signature << ") -> (#{definition[:component]})) -> ServiceEntry<#{definition[:service]}>"
 
     register_function_call = ".register("
     register_function_call << "#{definition[:service]}.self,"
     register_function_call << " name: \"#{name}\"," unless has_no_name
 
     resolve_function_signature = "resolve"
-    resolve_function_signature << definition[:component].gsub("<", "").gsub(">", "").gsub(".", "")
+    resolve_function_signature << definition[:component].delete("<").delete(">").delete(".")
     resolve_function_signature << "_#{name}" unless has_no_name
     resolve_function_signature << "("
-    resolve_function_signature << argument_hashes.each_with_index.map {|a,i| "#{a[:argument_name] + ' ' if i==0}#{a[:argument_name]}: #{a[:argument_type]}"}.join(", ") unless (argument_hashes.nil? || argument_hashes.empty?)
+    resolve_function_signature << argument_hashes.each_with_index.map { |a, i| "#{a[:argument_name] + ' ' if i == 0}#{a[:argument_name]}: #{a[:argument_type]}" }.join(", ") unless argument_hashes.nil? || argument_hashes.empty?
     resolve_function_signature << ") -> #{definition[:component]}"
 
     resolve_function_call = ".resolve("
@@ -183,13 +181,10 @@ def serialize_hash_to_CSV(hash, output_filename)
   if output_filename.nil?
     puts code
   else
-    File.open(output_filename, 'w') do |file_to_write_to|
+    File.open(output_filename, "w") do |file_to_write_to|
       file_to_write_to.puts code
     end
   end
-
 end
 
-if __FILE__ == $0
-  main()
-end
+main if __FILE__ == $PROGRAM_NAME

erb/container.erb

@@ -9,7 +9,7 @@ import  <%= dependency %>
 extension Resolvable {
 <% @content_array.each do |hash| %>
     func <%= hash[:resolve_function_signature] %> {
-        return self<%= hash[:resolve_function_call] %><%= ", argument: #{hash[:arguments][0][:argument_name]}" if !hash[:arguments].nil? && hash[:arguments].count == 1 -%><%= ", arguments: (#{hash[:arguments].map {|a| a[:argument_name]}.join(', ')})" if !hash[:arguments].nil? && hash[:arguments].count > 1 -%>)<%=hash[:service] != hash[:component] ? " as! #{hash[:component]}" : "!"%>
+        return self<%= hash[:resolve_function_call] %><%= ", argument: #{hash[:arguments][0][:argument_name]}" if !hash[:arguments].nil? && hash[:arguments].count == 1 -%><%= ", arguments: (#{hash[:arguments].map {|a| a[:argument_name]}.join(", ")})" if !hash[:arguments].nil? && hash[:arguments].count > 1 -%>)<%=hash[:service] != hash[:component] ? " as! #{hash[:component]}" : "!"%>
     }
 <% end -%>
 }

source/YMLParser.rb

@@ -1,6 +1,6 @@
+# responsible for parsing the csv files
 class CSVParser
-
-  def parse_CSV(input_filename)
+  def parse_csv(input_filename)
     result_hash = {
       DEPENDENCIES: [],
       DEFINITIONS: []
@@ -13,22 +13,22 @@ def parse_CSV(input_filename)
         # ignores empty lines
       elsif line.start_with?("#")
         # detect command
-        if(line.start_with?("#ADD_DEPENDENCY "))
+        if line.start_with?("#ADD_DEPENDENCY ")
           result_hash[:DEPENDENCIES].push(line.split(" ")[1])
-        elsif(line.start_with?("# ADD_DEPENDENCY "))
+        elsif line.start_with?("# ADD_DEPENDENCY ")
           result_hash[:DEPENDENCIES].push(line.split(" ")[2])
         end
       elsif line.start_with?("//")
         # ignores comments
       else
-        array = line.split(";").map { |a| a.strip }
+        array = line.split(";").map(&:strip)
         arguments = array[3..-1]
         argument_hashes = nil
         unless arguments.nil?
-          arguments.reject { |a| a.empty? }
+          arguments.reject(&:empty?)
           argument_hashes = arguments.map do |a|
             hash = nil
-            if(a.include?(":"))
+            if a.include?(":")
               hash = {
                 argument_name: a.split(":").first.strip,
                 argument_type: a.split(":").last.strip
@@ -57,7 +57,6 @@ def parse_CSV(input_filename)
         result_hash[:DEFINITIONS].push hash
       end
     end
-    return result_hash
+    result_hash
   end
-
 end