reality-generators 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b53895e619304dc52428b481c0b1922695039ae
-  data.tar.gz: 3d4aa146c64150afce33a34dc43d9a538b9337cb
+  metadata.gz: 6449615da8a7084e231edf77e9846601f1b8ac55
+  data.tar.gz: e15cf1793acaf16344595204197d8d34e1e6882d
 SHA512:
-  metadata.gz: 4aae8b67f7bab3ab657620070fddb640789a2b610063ffa5ef9419ba124b639d1c5fb1bcdbf1b33b177e9d537ea38c1c10e5a2b4c00c27b5e0cb614f4afd0f21
-  data.tar.gz: aa5c5fad5e2ff7a0b0af90a32c5b341ac6e7e3aa5297d62efb72ef9e89226a55717e032240166f7808b6ce482bebb7c0c3c61f0f1500ee471cc8b3d530701fda
+  metadata.gz: 2a2641ffdf3ffffef5120a76debe8a462a98c5d79b3a271f48f56ca32c43a2406db01aaa3e738fe468d34668669494a9b07eac3450635b79e1085dd05e809a8c
+  data.tar.gz: 589ed998dfde9b98773a7ffb1d69ab212812af37db233975de9f3b0cecc4a115f5aed751a78250d5e70feaca5866808d5197a7dea35f3849147f4584346f31b1

data/lib/reality/generators.rb

@@ -30,5 +30,6 @@ require 'reality/generators/generator'
 require 'reality/generators/standard_template_set'
 require 'reality/generators/standard_artifact_dsl'
 require 'reality/generators/rake_integration'
+require 'reality/generators/runner'
 
 require 'reality/generators/buildr_integration'

data/lib/reality/generators/runner.rb

@@ -0,0 +1,233 @@
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+module Reality #nodoc
+  module Generators #nodoc
+    # A base class for writing command line tasks that load one or more
+    # descriptors and run zer or more generators/template_sets
+    class BaseRunner
+      EXIT_CODE_SUCCESS = 0
+      EXIT_CODE_UNABLE_TO_PARSE_ARGS = 50
+      EXIT_CODE_UNEXPECTED_ARGS = 51
+      EXIT_CODE_DESCRIPTOR_NO_EXIST = 52
+      EXIT_CODE_NO_ELEMENT_NAME_SPECIFIED = 53
+      EXIT_CODE_ELEMENT_NAME_NO_EXIST = 54
+
+      def initialize
+        @descriptors = []
+        @generators = self.default_generators
+        @target_dir = nil
+        @element_name = nil
+        @element_type_name_char_code = nil
+        @verbose = false
+        @debug = false
+        @tool_name = File.basename($PROGRAM_NAME)
+      end
+
+      def default_generators
+        []
+      end
+
+      def default_descriptor
+        raise 'default_descriptor not implemented'
+      end
+
+      def element_type_name
+        raise 'repository not implemented'
+      end
+
+      def log_container
+        raise 'log_container not implemented'
+      end
+
+      def instance_container
+        raise 'instance_container not implemented'
+      end
+
+      def template_set_container
+        raise 'template_set_container not implemented'
+      end
+
+      def additional_loggers
+        []
+      end
+
+      def element_type_name_char_code
+        @element_type_name_char_code || self.element_type_name[0, 1]
+      end
+
+      def default_target_dir
+        'generated'
+      end
+
+      attr_writer :verbose
+
+      def verbose?
+        !!@verbose
+      end
+
+      attr_writer :debug
+
+      def debug?
+        !!@debug
+      end
+
+      attr_writer :target_dir
+
+      def target_dir
+        @target_dir || self.default_target_dir
+      end
+
+      attr_accessor :generators
+
+      attr_accessor :descriptors
+
+      attr_accessor :element_name
+
+      attr_accessor :tool_name
+
+      def run
+        require 'optparse'
+
+        opt_parser = OptionParser.new do |opt|
+          opt.banner = "Usage: #{tool_name} [OPTIONS]"
+          opt.separator ''
+          opt.separator 'Options'
+
+          opt.on('-d', '--descriptor FILENAME', "the filename of a descriptor to be loaded. Multiple descriptors may be loaded. Defaults to 'resources.rb' if none specified.") do |arg|
+            self.descriptors << arg
+          end
+
+          opt.on("-#{self.element_type_name_char_code}",
+                 "--#{self.element_type_name} NAME",
+                 "the name of the #{self.element_type_name} to load. Defaults to the the name of the only #{element_type_name} if there is only one #{self.element_type_name} defined by the descriptors, otherwise must be specified.") do |arg|
+            self.element_name = arg
+          end
+
+          opt.on('-g', '--generators GENERATORS', "the comma separated list of generators to run. Defaults to #{default_generators.inspect}") do |arg|
+            self.generators += arg.split(',').collect { |g| g.to_sym }
+          end
+
+          opt.on('-t', '--target-dir DIR', "the directory into which to generate artifacts. Defaults to '#{self.default_target_dir}'.") do |arg|
+            self.target_dir = arg
+          end
+
+          opt.on('-v', '--verbose', 'turn on verbose logging.') do
+            self.verbose = true
+          end
+
+          opt.on('--debug', 'turn on debug logging.') do
+            self.verbose = true
+            self.debug = true
+          end
+
+          opt.on('-h', '--help', 'help') do
+            puts opt_parser
+            exit(EXIT_CODE_SUCCESS)
+          end
+        end
+
+        args = ARGV.dup
+        begin
+          opt_parser.parse!(args)
+        rescue => e
+          puts "Error: #{e.message}"
+          exit(EXIT_CODE_UNABLE_TO_PARSE_ARGS)
+        end
+
+        if args.length != 0
+          puts "Unexpected arguments #{args.inspect} passed to command"
+          puts opt_parser
+          exit(EXIT_CODE_UNEXPECTED_ARGS)
+        end
+
+        loggers = [self.log_container.const_get(:Logger), Reality::Generators::Logger] + self.additional_loggers
+
+        log_level = debug? ? ::Logger::DEBUG : verbose? ? ::Logger::INFO : ::Logger::WARN
+        Reality::Logging.set_levels(log_level, *loggers)
+
+        if 0 == self.descriptors.size
+          puts "No descriptor specified. Defaulting to #{default_descriptor}"
+          self.descriptors << default_descriptor
+        end
+
+        if verbose?
+          puts "#{Reality::Naming.humanize(self.element_type_name)} Name: #{self.element_name || 'Unspecified'}"
+          puts "Target Dir: #{self.target_dir}"
+          if self.descriptors.size == 1
+            puts "Descriptor: #{self.descriptors[0]}"
+          else
+            puts 'Descriptors:'
+            self.descriptors.each do |descriptor|
+              puts "  * #{descriptor}"
+            end
+          end
+          puts 'Generators:'
+          self.generators.each do |generator|
+            puts "  * #{generator}"
+          end
+        end
+
+        self.descriptors.each do |descriptor|
+          puts "Loading descriptor: #{descriptor}" if verbose?
+          filename = File.expand_path(descriptor)
+          unless File.exist?(filename)
+            puts "Descriptor file #{filename} does not exist"
+            exit(EXIT_CODE_DESCRIPTOR_NO_EXIST)
+          end
+          load_descriptor(filename)
+          puts "Descriptor loaded: #{descriptor}" if verbose?
+        end
+
+        unless self.element_name
+          element_names = self.instance_container.send(Reality::Naming.pluralize(self.element_type_name).to_sym).collect { |r| r.name }
+          if element_names.size == 1
+            self.element_name = element_names[0]
+            puts "Derived default #{Reality::Naming.humanize(self.element_type_name)} name: #{self.element_name}" if verbose?
+          else
+            puts "No #{Reality::Naming.humanize(self.element_type_name).downcase} name specified and #{Reality::Naming.humanize(element_type_name).downcase} name could not be determined. Please specify one of the valid #{Reality::Naming.humanize(self.element_type_name).downcase} names: #{element_names.join(', ')}"
+            exit(EXIT_CODE_NO_ELEMENT_NAME_SPECIFIED)
+          end
+        end
+
+        unless self.instance_container.send(:"#{self.element_type_name}_by_name?", self.element_name)
+          puts "Specified #{Reality::Naming.humanize(self.element_type_name).downcase} name '#{self.element_name}' does not exist in descriptors."
+          exit(EXIT_CODE_ELEMENT_NAME_NO_EXIST)
+        end
+
+        element = self.instance_container.send(:"#{self.element_type_name}_by_name", self.element_name)
+
+        self.template_set_container.generator.generate(element_type_name.to_sym,
+                                                       element,
+                                                       File.expand_path(self.target_dir),
+                                                       self.generators,
+                                                       nil)
+
+        exit EXIT_CODE_SUCCESS
+      end
+
+      def load_descriptor(filename)
+        pre_load(filename)
+        require filename
+        post_load(filename)
+      end
+
+      def pre_load(filename)
+      end
+
+      def post_load(filename)
+      end
+    end
+  end
+end

data/reality-generators.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name               = %q{reality-generators}
-  s.version            = '1.11.0'
+  s.version            = '1.12.0'
   s.platform           = Gem::Platform::RUBY
 
   s.authors            = ['Peter Donald']

data/test/generators/gentest.rb

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'reality/generators'
+
+module GenTest
+  Reality::Logging.configure(GenTest, ::Logger::WARN)
+
+  class Repository < Reality.base_element(:name => true)
+  end
+
+  class RepositoryTemplate < Reality::Generators::SingleFileOutputTemplate
+    def render_to_string(context_binding)
+      eval('"Repository: #{repository.name}"', context_binding)
+    end
+  end
+
+  class RepositoryTemplate2 < Reality::Generators::SingleFileOutputTemplate
+    def render_to_string(context_binding)
+      eval('"Repository: #{repository.name} (Template2)"', context_binding)
+    end
+  end
+
+  module TestTemplateSetContainer
+    class << self
+      include Reality::Generators::TemplateSetContainer
+    end
+  end
+
+  TestTemplateSetContainer.target_manager.target(:repository)
+
+  TestTemplateSetContainer.template_set(:test) do |t|
+    RepositoryTemplate.new(t, [], :repository, 'repository.java', 'main/java/#{repository.name}.java')
+  end
+
+  TestTemplateSetContainer.template_set(:test2) do |t|
+    RepositoryTemplate2.new(t, [], :repository, 'repository_t2.java', 'main/java/#{repository.name}Template2.java')
+  end
+
+  class << self
+    def repositories
+      repository_map.values
+    end
+
+    def repository_map
+      @repository_map ||= {}
+    end
+
+    def repository(name)
+      repository = Repository.new(name)
+      self.repository_map[name.to_s] = repository
+      yield repository if block_given?
+      repository
+    end
+
+    def repository_by_name(name)
+      self.repository_map[name.to_s] || (raise "No such repository #{name}")
+    end
+
+    def repository_by_name?(name)
+      !!self.repository_map[name.to_s]
+    end
+  end
+
+  class Runner < Reality::Generators::BaseRunner
+    def default_descriptor
+      'repository.rb'
+    end
+
+    def element_type_name
+      'repository'
+    end
+
+    def log_container
+      GenTest
+    end
+
+    def instance_container
+      GenTest
+    end
+
+    def template_set_container
+      TestTemplateSetContainer
+    end
+  end
+end
+
+GenTest::Runner.new.run

data/test/generators/test_runner.rb

@@ -0,0 +1,229 @@
+require File.expand_path('../../helper', __FILE__)
+require 'date'
+
+class Reality::Generators::TestRunner < Reality::TestCase
+  def test_basic_runner_execution
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner((%W(--descriptor #{descriptor} --generators test --target-dir #{target_directory})))
+
+    repo_file = "#{target_directory}/main/java/MyRepo.java"
+    assert_equal true, File.directory?("#{target_directory}/main/java")
+    assert_equal true, File.exist?(repo_file)
+    assert_equal 'Repository: MyRepo', IO.read(repo_file)
+    assert_equal '', output
+  end
+
+  def test_verbose_runner_execution
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner((%W(--descriptor #{descriptor} --generators test --target-dir #{target_directory} --verbose)))
+
+    target_file = "#{target_directory}/main/java/MyRepo.java"
+    assert_equal 'Repository: MyRepo', IO.read(target_file)
+
+    assert_equal <<OUTPUT, output
+Repository Name: Unspecified
+Target Dir: #{target_directory}
+Descriptor: #{descriptor}
+Generators:
+  * test
+Loading descriptor: #{descriptor}
+Descriptor loaded: #{descriptor}
+Derived default Repository name: MyRepo
+Generator completed
+OUTPUT
+  end
+
+  def test_debug_runner_execution
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner((%W(--descriptor #{descriptor} --generators test --target-dir #{target_directory} --debug)))
+
+    target_file = "#{target_directory}/main/java/MyRepo.java"
+    assert_equal 'Repository: MyRepo', IO.read(target_file)
+
+    assert_equal <<OUTPUT, output
+Repository Name: Unspecified
+Target Dir: #{target_directory}
+Descriptor: #{descriptor}
+Generators:
+  * test
+Loading descriptor: #{descriptor}
+Descriptor loaded: #{descriptor}
+Derived default Repository name: MyRepo
+Templates to process: ["test:repository.java"]
+Evaluating template: test:repository.java
+Generating test:repository.java for repository MyRepo
+Generated test:repository.java for repository MyRepo to #{target_file}
+Generator completed
+OUTPUT
+  end
+
+  def test_debug_runner_execution_multiple_descriptors_multiple_templates
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+    descriptor2 = "#{temp_dir}/repository2.rb"
+    File.write(descriptor2, '')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner((%W(--descriptor #{descriptor} --descriptor #{descriptor2} --generators test,test2 --target-dir #{target_directory} --debug)))
+
+    target_file = "#{target_directory}/main/java/MyRepo.java"
+    target_file2 = "#{target_directory}/main/java/MyRepoTemplate2.java"
+    assert_equal 'Repository: MyRepo', IO.read(target_file)
+    assert_equal 'Repository: MyRepo (Template2)', IO.read(target_file2)
+
+    expected = <<OUTPUT
+Repository Name: Unspecified
+Target Dir: #{target_directory}
+Descriptors:
+  * #{descriptor}
+  * #{descriptor2}
+Generators:
+  * test
+  * test2
+Loading descriptor: #{descriptor}
+Descriptor loaded: #{descriptor}
+Loading descriptor: #{descriptor2}
+Descriptor loaded: #{descriptor2}
+Derived default Repository name: MyRepo
+Templates to process: ["test:repository.java", "test2:repository_t2.java"]
+Evaluating template: test:repository.java
+Generating test:repository.java for repository MyRepo
+Generated test:repository.java for repository MyRepo to #{target_file}
+Evaluating template: test2:repository_t2.java
+Generating test2:repository_t2.java for repository MyRepo
+Generated test2:repository_t2.java for repository MyRepo to #{target_file2}
+Generator completed
+OUTPUT
+    assert_equal expected.to_s, output.to_s
+
+    FileUtils.rm_rf target_directory
+    output2 = run_runner((%W(--descriptor #{descriptor} --descriptor #{descriptor2} --generators test --generators test2 --target-dir #{target_directory} --debug)))
+    assert_equal expected, output2
+  end
+
+  def test_multiple_repositories_without_explicit_repository
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+    descriptor2 = "#{temp_dir}/repository2.rb"
+    File.write(descriptor2, 'GenTest.repository(:MyRepo2)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner(%W(--descriptor #{descriptor} --descriptor #{descriptor2} --target-dir #{target_directory}),
+                        Reality::Generators::BaseRunner::EXIT_CODE_NO_ELEMENT_NAME_SPECIFIED)
+
+    expected = "No repository name specified and repository name could not be determined. Please specify one of the valid repository names: MyRepo, MyRepo2\n"
+    assert_equal expected, output
+  end
+
+  def test_multiple_repositories_with_explicit_repository
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+    descriptor2 = "#{temp_dir}/repository2.rb"
+    File.write(descriptor2, 'GenTest.repository(:MyRepo2)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner(%W(--descriptor #{descriptor} --descriptor #{descriptor2} --target-dir #{target_directory} --repository MyRepo))
+
+    assert_equal '', output
+  end
+
+  def test_element_name_specified_but_no_exist
+    descriptor = "#{temp_dir}/repository.rb"
+    File.write(descriptor, 'GenTest.repository(:MyRepo)')
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner(%W(--descriptor #{descriptor} --target-dir #{target_directory} --repository SomeOtherMyRepo),
+                        Reality::Generators::BaseRunner::EXIT_CODE_ELEMENT_NAME_NO_EXIST)
+
+    expected = "Specified repository name 'SomeOtherMyRepo' does not exist in descriptors.\n"
+    assert_equal expected, output
+  end
+
+  def test_descriptor_no_exist
+    descriptor = "#{temp_dir}/repository.rb"
+
+    target_directory = "#{temp_dir}/generated/erb_template"
+
+    output = run_runner(%W(--descriptor #{descriptor} --target-dir #{target_directory}),
+                        Reality::Generators::BaseRunner::EXIT_CODE_DESCRIPTOR_NO_EXIST)
+
+    expected = "Descriptor file #{descriptor} does not exist\n"
+    assert_equal expected, output
+  end
+
+  def test_invalid_args
+    output = run_runner(%W(--bad-arg), Reality::Generators::BaseRunner::EXIT_CODE_UNABLE_TO_PARSE_ARGS)
+
+    expected = "Error: invalid option: --bad-arg\n"
+    assert_equal expected, output
+  end
+
+  def test_unexpected_arg
+    output = run_runner(%W(bad-arg), Reality::Generators::BaseRunner::EXIT_CODE_UNEXPECTED_ARGS)
+
+    expected = <<OUTPUT
+Unexpected arguments ["bad-arg"] passed to command
+Usage: gentest.rb [OPTIONS]
+
+Options
+    -d, --descriptor FILENAME        the filename of a descriptor to be loaded. Multiple descriptors may be loaded. Defaults to 'resources.rb' if none specified.
+    -r, --repository NAME            the name of the repository to load. Defaults to the the name of the only repository if there is only one repository defined by the descriptors, otherwise must be specified.
+    -g, --generators GENERATORS      the comma separated list of generators to run. Defaults to []
+    -t, --target-dir DIR             the directory into which to generate artifacts. Defaults to 'generated'.
+    -v, --verbose                    turn on verbose logging.
+        --debug                      turn on debug logging.
+    -h, --help                       help
+OUTPUT
+    assert_equal expected, output
+  end
+
+  def test_help_invocation
+    output = run_runner(%w(--help))
+
+    assert_equal <<OUTPUT, output
+Usage: gentest.rb [OPTIONS]
+
+Options
+    -d, --descriptor FILENAME        the filename of a descriptor to be loaded. Multiple descriptors may be loaded. Defaults to 'resources.rb' if none specified.
+    -r, --repository NAME            the name of the repository to load. Defaults to the the name of the only repository if there is only one repository defined by the descriptors, otherwise must be specified.
+    -g, --generators GENERATORS      the comma separated list of generators to run. Defaults to []
+    -t, --target-dir DIR             the directory into which to generate artifacts. Defaults to 'generated'.
+    -v, --verbose                    turn on verbose logging.
+        --debug                      turn on debug logging.
+    -h, --help                       help
+OUTPUT
+  end
+
+  def run_gentest(descriptor, generators, target_directory, additional_args = '')
+    run_runner((%W(--descriptor #{descriptor} --generators #{generators.join(',')} --target-dir #{target_directory} #{additional_args})))
+  end
+
+  def run_runner(args, expected_exitcode = Reality::Generators::BaseRunner::EXIT_CODE_SUCCESS)
+    prefix = (defined?(JRUBY_VERSION) || Gem.win_platform?) ? 'ruby ' : ''
+    command = File.expand_path("#{File.dirname(__FILE__)}/gentest.rb")
+    run_command("#{prefix}#{command} #{args.join(' ')}", expected_exitcode)
+  end
+
+  def run_command(command, expected_exitcode = 0)
+    output = `#{command}`
+    exitcode = $?.exitstatus
+    raise "Command failed to exit with code #{expected_exitcode} but returned #{exitcode}: #{command}\nOutput: #{output}" unless exitcode == expected_exitcode
+    output
+  end
+end

data/test/helper.rb

@@ -36,9 +36,13 @@ class Reality::TestCase < Minitest::Test
   end
 
   def teardown
-    unless @temp_dir.nil?
-      FileUtils.rm_rf @temp_dir unless ENV['NO_DELETE_DIR'] == 'true'
-      @temp_dir = nil
+    if passed?
+      unless @temp_dir.nil?
+        FileUtils.rm_rf @temp_dir unless ENV['NO_DELETE_DIR'] == 'true'
+        @temp_dir = nil
+      end
+    else
+      $stderr.puts "Test #{self.class.name}.#{name} Failed. Leaving working directory #{@temp_dir}"
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: reality-generators
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - Peter Donald
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-18 00:00:00.000000000 Z
+date: 2017-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reality-core
@@ -103,6 +103,7 @@ files:
 - lib/reality/generators/rake_integration.rb
 - lib/reality/generators/render_context.rb
 - lib/reality/generators/ruby_template.rb
+- lib/reality/generators/runner.rb
 - lib/reality/generators/standard_artifact_dsl.rb
 - lib/reality/generators/standard_template_set.rb
 - lib/reality/generators/target_manager.rb
@@ -110,6 +111,7 @@ files:
 - lib/reality/generators/template_set.rb
 - lib/reality/generators/template_set_container.rb
 - reality-generators.gemspec
+- test/generators/gentest.rb
 - test/generators/jpa/model.rb
 - test/generators/jpa/templates/mytemplate.java.erb
 - test/generators/jpa/templates/rubytemplate.java.rb
@@ -117,6 +119,7 @@ files:
 - test/generators/test_generator.rb
 - test/generators/test_render_context.rb
 - test/generators/test_ruby_template.rb
+- test/generators/test_runner.rb
 - test/generators/test_standard_artifact_dsl.rb
 - test/generators/test_standard_template_set.rb
 - test/generators/test_target_manager.rb