terse_ruby 0.1.0 → 0.1.1

data/test/expected_test_file_java.java

@@ -0,0 +1,22 @@
+public class PhoneNumber {
+	public String type;
+	public String number;
+	
+	public void testMethod1(String var) {
+		
+	}
+	
+	public static void testMethod2 {
+		
+	}
+	
+	private String privateMethod1;
+	
+	protected Integer protMeth1(Float var);
+	return Integer.valueOf(var);
+	
+}
+
+
+
+}

data/test/{expected_test_file.rb → expected_test_file_ruby.rb}

@@ -8,10 +8,10 @@ class AClass
 		require_relative "morethings"
 		puts "this is a real Ruby line"
 	end
-
+	
 	def method2
 	end
-
+	
 	def meth3
 		
 		attr_accessor :field1
@@ -30,13 +30,13 @@ module AModule
 	def m3
 		
 	end
-
+	
 	def method2
 	end
 	
 	def c m r i d e a r w
 	end
-
+	
 	def wraedirmc
 	end
 end

data/test/test_expansion_java.rb

@@ -0,0 +1,75 @@
+require "test/unit"
+require_relative "../lib/terse_ruby"
+
+class TestExpansionJava < Test::Unit::TestCase
+        
+    @@terse_file = "test_file_java.txt"
+    @@expanded_file = "test_file_java.java"
+    @@premade_file = "expected_test_file_java.java"
+    @@argv_altered = false
+
+    # not used - invoking via cmd means that the gem has to be rebuild & reinstalled after every code change, which does not lend itself to a speedy dev process
+    # TODO add test that deliberately invokes via system
+    @@cmd = "ruby -e \"require 'terse_ruby'; TerseJava.scan_files ARGV\" #{@@terse_file}"
+
+    def switch_dir
+        # Change this so we know where the expaneded file will be created
+        @previous_wd ||= Dir.getwd # Preserve the old wd so we can switch back to it after the test
+        Dir.chdir File.expand_path(File.dirname(__FILE__))    
+    end
+
+    def run_cmd
+        # system @@cmd # old mechanism; don't do this, call TerseRuby.scan_files ARGV instead
+
+        # ARGV is preserved from one test_ to the next, so we should only alter it once
+        unless @@argv_altered
+            ARGV << @@terse_file
+            ARGV << "-v"
+            @@argv_altered = true
+        end
+        TerseJava.scan_files ARGV
+    end
+
+    # Switch to the same directory as this unit-test file, and check that the expected file is not present
+    def setup
+        switch_dir
+        raise "terse_ruby unit-tests found a pre-existing #{@@expanded_file} in #{Dir.getwd}; unit-tests will clean up after themselves but will not alter pre-existing files" if File.file? @@expanded_file
+        raise "terse_ruby unit-tests could not locate the starting test file #{@@terse_file} in #{Dir.getwd}" unless File.file? @@terse_file
+    end
+
+    # Tests that the test file is expanded with the expected name
+    def test_expanded_name
+        assert_false(File.file?(@@expanded_file), "Expanded test file #{@@expanded_file} already existed before running test")
+        run_cmd
+        assert(File.exists?(@@expanded_file), "terse_ruby did not expand #{@@terse_file} into a file with name #{@@expanded_file}")
+        assert(File.file?(@@expanded_file), "terse_ruby did not expand #{@@terse_file} into a file with name #{@@expanded_file}")
+    end
+
+    # Tests that the test file is expanded into the expected form
+    # Expand the file, then compare the two line-by-line
+    def test_expansion
+        run_cmd
+        assert(File.file?(@@expanded_file), "terse_ruby did not expand #{@@terse_file} into a file with name #{@@expanded_file}")
+        
+        expected_lines = File.readlines(@@premade_file)
+        actual_lines = File.readlines(@@expanded_file)
+        
+        assert_equal(expected_lines.size, actual_lines.size, "Expanded file did not have the expected number of lines")
+        
+        # As expected_lines and actual_lines are arrays, we can just use Array#==
+        assert_equal(expected_lines.sort, actual_lines.sort, "Expanded file did not have the expected lines in the expected order")
+        assert_equal(expected_lines, actual_lines, "Expanded file did not have the expected lines")
+    end
+
+    # Delete the expected file from the expected dir
+    def teardown
+        if File.file?(@@expanded_file)
+            count = File.delete @@expanded_file
+            raise "Teardown failed to delete expanded file #{@@expanded_file}" unless count == 1
+            raise "Teardown failed to delete expanded file #{@@expanded_file}" if File.file?(@@expanded_file)
+            puts "Teardown deleted expanded file #{@@expanded_file}"
+        end
+        Dir.chdir @previous_wd # restore the working directory to what it was previously
+    end
+    
+end

data/test/{test_expansion.rb → test_expansion_ruby.rb}

@@ -1,11 +1,15 @@
 require "test/unit"
 require_relative "../lib/terse_ruby"
 
-class TestExpansion < Test::Unit::TestCase
+class TestExpansionRuby < Test::Unit::TestCase
         
-    @@terse_file = "test_file.txt"
-    @@expanded_file = "test_file.rb"
-    @@premade_file = "expected_test_file.rb"
+    @@terse_file = "test_file_ruby.txt"
+    @@expanded_file = "test_file_ruby.rb"
+    @@premade_file = "expected_test_file_ruby.rb"
+    @@argv_altered = false
+
+    # not used - invoking via cmd means that the gem has to be rebuild & reinstalled after every code change, which does not lend itself to a speedy dev process
+    # TODO add test that deliberately invokes via system
     @@cmd = "ruby -e \"require 'terse_ruby'; TerseRuby.scan_files ARGV\" #{@@terse_file}"
 
     def switch_dir
@@ -15,7 +19,14 @@ class TestExpansion < Test::Unit::TestCase
     end
 
     def run_cmd
-        system @@cmd
+        # system @@cmd # old mechanism; don't do this, call TerseRuby.scan_files ARGV instead
+
+        # ARGV is preserved from one test_ to the next, so we should only alter it once
+        unless @@argv_altered
+            ARGV << @@terse_file
+            @@argv_altered = true
+        end
+        TerseRuby.scan_files ARGV
     end
 
     # Switch to the same directory as this unit-test file, and check that the expected file is not present

data/test/test_file_java.txt

@@ -0,0 +1,14 @@
+p c PhoneNumber
+	p s type
+	p s number
+	
+p v testMethod1(s var)
+
+p st v testMethod2
+
+	pv s privateMethod1
+
+	pt i protMeth1(f var)
+	r Integer.valueOf(var)
+
+

metadata

@@ -1,15 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: terse_ruby
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Richard Morrisby
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-26 00:00:00.000000000 Z
-dependencies: []
+date: 2017-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: more-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: argv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 description: A utility to convert 'shorthand' Ruby into genuine Ruby. See README for
   more details.
 email: rmorrisby@gmail.com
@@ -19,15 +59,22 @@ extra_rdoc_files: []
 files:
 - LICENCE.txt
 - README.txt
-- bin/terse_ruby.rb
+- build.rb
+- lib/terse/format.rb
+- lib/terse/keyword.rb
+- lib/terse/keyword_java.rb
+- lib/terse/keyword_ruby.rb
+- lib/terse/scan.rb
+- lib/terse/settings.rb
+- lib/terse_java.rb
 - lib/terse_ruby.rb
-- lib/terse_ruby/format.rb
-- lib/terse_ruby/keyword.rb
-- lib/terse_ruby/scan.rb
 - terse_ruby.gemspec
-- test/expected_test_file.rb
-- test/test_expansion.rb
-- test/test_file.txt
+- test/expected_test_file_java.java
+- test/expected_test_file_ruby.rb
+- test/test_expansion_java.rb
+- test/test_expansion_ruby.rb
+- test/test_file_java.txt
+- test/test_file_ruby.txt
 homepage: https://rubygems.org/gems/terse_ruby
 licenses:
 - MIT
@@ -48,9 +95,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
 summary: A utility to convert 'shorthand' Ruby into genuine Ruby.
 test_files:
-- test/test_expansion.rb
+- test/test_expansion_java.rb
+- test/test_expansion_ruby.rb

data/bin/terse_ruby.rb

@@ -1,59 +0,0 @@
-# Terse Ruby
-# A simple utility to allow you to write shorthand for Ruby classes; the utility will then convert this shorthand file into a genuine Ruby .rb file (either writing a new file or overwriting)
-#
-# E.g. terse_file.txt contains :
-#
-# req a_gem
-# c AClass
-#     i AnInclude
-#     d method1
-#
-# Then Terse Ruby will write a new file terse_file.rb containing :
-#
-# require "a_gem"
-# class AClass
-#     include AnInclude
-#     def method1
-#     end
-# end  
-#
-#
-# Rules :
-# Terse Ruby will look through the supplied files and convert certain keywords at the start of lines :
-# c -> class
-# m -> module
-# r -> require (and will wrap the required item in " " if needed)
-# i -> include
-# d -> def
-# e -> end (method, class & module ends will be added if a subsequent method, class or module is detected, or is end-of-file)
-# a -> attr_accessor (and prefixes the variable name with : to make it a symbol)
-# r -> attr_reader (and prefixes the variable name with : to make it a symbol)
-# w -> attr_writer (and prefixes the variable name with : to make it a symbol)
-#
-# All remaining text in the line is not altered, even if a matching keyword is present, because the keywords need to be at the beginning of the line (ignoring leading whitespace)
-#
-#
-# Flags :
-# v : verbose mode
-# o : overwrite - if the new file already exists, the existing file will be overwritten  
-#
-#
-# Invokation :
-# terse_ruby can be directly invoked from the command-line with :
-#
-# ruby -e "require 'terse_ruby'; TerseRuby.scan_files ARGV" [one or more files] [flags]
-#
-# e.g.
-#
-# ruby -e "require 'terse_ruby'; TerseRuby.scan_files ARGV" terse_file1.txt terse_file2.txt -o -v
-#
-# Alternatively, the below two lines are all you need to run terse_ruby within your own Ruby file :
-#
-# require_relative "../lib/terse_ruby"
-# TerseRuby.scan_files ARGV
-#
-# (if ARGV have not been supplied, you'll need to construct this object yourself first)
-
-
-require_relative "../lib/terse_ruby"
-TerseRuby.scan_files ARGV

data/lib/terse_ruby/scan.rb

@@ -1,147 +0,0 @@
-require "more_ruby"
-require_relative "keyword"
-require_relative "format"
-
-module TerseRuby
-
-    # This Scan class does the meat of the work
-    # TODO generate to_s, ==, initialize
-    class Scan
-
-        # The main method. ARGV from the invokation are passed in to here
-        def self.scan_files(argv)
-            puts "\nTerse Ruby called"
-
-            keywords = TerseRuby::Keyword.generate_keywords
-            flags = argv.options
-            @verbose = flags.include_any?("v", "verbose")
-            @overwrite = flags.include_any?("o", "overwrite", "w", "write")
-            @no_formatting = flags.include_any?("n", "noformatting")
-
-            files = argv.values
-
-            if files.size < 1
-                puts "No files supplied"
-            else
-                files.each do |f|
-                    is_file? f
-                end
-                pv "Will scan #{files.size} file#{plural_or_not files}"
-                files.each do |f|
-                    is_file? f
-                    filename = File.basename f
-                    new_filename = gen_new_filename f
-                    newlines = []
-                    lines = File.readlines f
-                    pv "File #{filename} has #{lines.size} line#{plural_or_not lines}"
-                    # If we detect the start of a new class/method/etc. before the last one has been closed
-                    # then insert an "end" to close it off
-                    needs_top_level_end = false
-                    needs_inner_end = false
-                    insert_end = false
-                    lines.each do |l|
-                        line = l.chomp
-                        newline = line # keep the orginial line unless we detect a match 
-                        keywords.each do |k|
-                            if line =~ k.regex
-                                pv "\nMatch found against line --> #{line}"            
-                                pv "Matched -------------------> " + $2
-                                if k.is_end
-                                    if needs_inner_end
-                                        needs_inner_end = false
-                                    elsif needs_top_level_end
-                                        needs_top_level_end = false
-                                    end
-                                    insert_end = false
-                                end
-                                
-                                if k.needs_inner_end
-                                    if needs_inner_end
-                                        newlines << "end"
-                                        # keep needs_inner_end true as we need to watch for an end for this new match
-                                    else
-                                        needs_inner_end = true # set in readiness for the next match
-                                    end
-                                end
-                                
-                                if k.needs_top_level_end
-                                    if needs_inner_end
-                                        newlines << "end"
-                                        needs_inner_end = false
-                                    end
-                                    if needs_top_level_end
-                                        newlines << "end"
-                                        # keep needs_top_level_end true as we need to watch for an end for this new match
-                                    else
-                                        needs_top_level_end = true # set in readiness for the next match
-                                    end
-                                end
-                                
-                                if k.try_follow_on_regex && line =~ k.follow_on_regex
-                                    # puts ""
-                                    # $& is the entire match, not just the bits in ( )
-                                    remainder = line[$&.size .. -1]
-                                    follow_on = (eval k.follow_on_substitute).inspect
-                                    newline = "#{$1}#{k.substitute} #{follow_on}#{remainder}"
-                                else
-                                    remainder = line[($1.size + $2.size) .. -1]
-                                    newline = "#{$1}#{k.substitute}#{remainder}"
-                                end
-                                
-                                pv "Line will become ----------> " + newline
-                                break
-                            end # end if regex        
-                        end # end keywords.each
-                        newlines << newline
-                    end # end lines.each
-                    # Add end lines to end of file if necessary
-                    newlines << "end" if needs_inner_end
-                    newlines << "end" if needs_top_level_end
-                    
-                    # Apply indentation
-                    newlines = TerseRuby::Format.indent(newlines) unless @no_formatting
-                    
-                    # Add newlines between the end of a method and the start of the next, if needed 
-                    newlines = TerseRuby::Format.space_lines(newlines) unless @no_formatting
-                    
-                    # Write out the new file
-                    File.open(new_filename, "w") do |new_f|
-                        newlines.each do |l|
-                            new_f.puts l
-                        end
-                    end
-                    puts "\nWrote file #{new_filename}"
-                end # end else
-            end # end ARGV.size
-            puts "\nTerse Ruby finished"
-        end # end scan_files
-
-        # Returns an "s" string if the size of the item (item.size) is > 1; returns "" otherwise
-        def self.plural_or_not item
-            item.size == 1 ? "" : "s"
-        end
-
-        def self.is_file? f
-            raise "Could not locate file at " + File.absolute_path(f) unless File.file?(f)
-        end
-
-        # Rules :
-        # Keep base-name, change ext. to .rb, write to current working dir
-        def self.gen_new_filename f
-            path = Dir.getwd
-            name = File.basename_no_ext f
-            ext = ".rb"
-            new_f = File.join(path, name) + ext
-
-            if File.file?(new_f)
-                puts "New file wll overwrite existing file " + new_f
-                raise "Overwrite flag not specified; will not overwrite existing file " + new_f if !@overwrite
-            end
-            new_f
-        end
-
-        def self.pv s
-            puts s if @verbose
-        end
-    end
-end