rdm 0.4.7 → 0.4.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 64cbcdd605d4efd34e3351f826ea81f4106c76c1
-  data.tar.gz: 403f9e6c596783ea2312c062790ce6dcd708c46d
+  metadata.gz: bd2b98cd1a4c0604e5b22d4681bc8dd0ab957025
+  data.tar.gz: bc64b5cd0850ea5a639a3d2cb9312b487f0c9afa
 SHA512:
-  metadata.gz: ec9ed5d4113c4e0cca8d0f0a4a654896b20c3f88fe5450df78032a1160634e08ad427f231477f1fb6cd8f701cc093fbcd39c60c0e01e0a567690de69bbf87767
-  data.tar.gz: 67ed2d03b2ed25d847d4f1bd28440563d1c2774b6c85235ad7617a947382d7a3ba97b38aadff768be197653146d4ff8d9d3560a269d580e17e5b6a99b403feb9
+  metadata.gz: 867ac2bf5b101620c1c0606d939ff92d3b5bc941908943b979613ab103fab111cebae5feb85511fa8ca943f5b3ba9245cc1242fe9835be2de55fe73a6e943d27
+  data.tar.gz: ee2208aacb31e87c3c9c82617df99caf040fa817ef9a8aca9fd87717db5a02d1ccb851fe369b91fe71b7fc4df3f73c9df5fb14fe35b962b19d8ab7283a1bbe4c

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rdm (0.4.7)
+    rdm (0.4.8)
       activesupport
       commander (~> 4.4)
 

data/README.md

@@ -92,7 +92,75 @@ require 'rdm'
 Rdm.init(File.expand_path("../../", __FILE__), :test)
 ```
 
+### Templates and generators
+Rdm has a set of generators using which you can make the creation of template structures automatic. 
+By default upon project initialization two generators are available: new package generator gen.package and configuration files generator gen.config. 
+
+**Syntax of the generator is the following:**
+```ruby
+rdm gen.package #{PACKAGE_NAME} --path #{PATH/TO/PACKAGE}
+rdm gen.config #{CONFIG_NAME}
+```
+To create new package “repository” and place it in the “infrastructure/repository” folder in your app you should type the following command: `rdm gen.package repository --path infrastructure/repository`
+You can also change the standard package generator or add custom templates to your project. All available templates are in the **".rdm/templates/:template_name"** folder of your project. The syntax to launch any template generator is the following:
+```ruby
+rdm gen.template #{TEMPLATE_NAME} --path #{PATH/TO/TEMPLATE}
+```
+This way if you want to create a structure using “repository” template in the “infrastructure/storage” folder of your app you should type the following command: `rdm gen.template repository --path infrastructure/storage`
+
+When copying the template you can use any variables and helpers methods. In order to get unknown variables that are contained in the templates, the Rdm will show the dialogue window requesting to type in their values. A previously defined variable is "package_subdir_name", it’s value is set in Rdm.packages file. To enter variables to templates a common erb syntax is used:
+```ruby
+require '<%=name%>_repository'
+```
+```ruby
+class <%= package_name %>
+  def initialize
+  end
+end
+```
+You can add helpers methods yourself to the **.rdm/helpers/render_helper.rb** and they will be available to use in the templates. 
+```ruby
+# .rdm/helpers/render_helper.rb
+module Rdm
+  module RenderHelper
+    def camelize(string, uppercase_first_letter = true)
+      # some staff
+    end
+  end
+end
+```
+```ruby
+# .rdm/templates/custom_template
+class <%= capitalize(package_name) %>
+  def initialize
+  end
+end
+```
+
+### Package compiler
+Rdm lets you make any package compliance easier, using only dependencies needed for it. Command syntax is the following:
+```ruby
+rdm compile.package #{PACKAGE_NAME} --path #{PATH/TO/COMPILED/PACKAGE}
+```
+By default the path value is **‘tmp/:package_name’**, where *:package_name* is changed to the name of the package. This way if you want to comply a ‘web’ package with all it’s dependencies in the '~/dev/web' directory type the following command: `rdm compile.package web --path '~/dev/web'`
+
+### Diff manager
+If you have VCS Git on your projects you can use it to get the list of packages that have undergone any changes. The command syntax is the following:
+```ruby
+rdm git.diff #{REVISION}
+```
+This way if you want to get a list of packages that have undergone changes compared to the development branch from the master branch, type this command: `rdm git.diff development`
+
+### Dependencies manager
+Rdm lets you to create a dependency tree for your packages. Syntax for the command is the following:
+```ruby
+rdm gen.deps #{PACKAGE_NAME}
+```
+This way if you want to display recursive list of dependencies for the ‘server’ package type in the following:
+`rdm gen.deps server`
+Values listed in the parentheses to the right of the package contain information on groups that have this package in them.
+
 
 ## Examples
 
-- [small dummy application](/example)
+- [small dummy application](/example)

data/bin/rdm

@@ -17,21 +17,23 @@ class RdmCliRunner
     program :description, 'Ruby Dependencies Manager'
 
     command :init do |c|
-      c.syntax = 'rdm init, [options]'
-      c.description = 'generates project scaffold in current folder'
-      c.summary = '> ' + c.description
-      c.example 'generate scaffold with minitest', 'rdm init --test=minitest'
-      c.example 'generate scaffold with rspec',    'rdm init --test=rspec'
-      c.example 'generate scaffold with irb',      'rdm init --console=irb'
-      c.example 'generate scaffold with pry',      'rdm init --console=pry'
-      c.option '--test FRAMEWORK', TESTFRAMEWORKS, "select test framework: #{TESTFRAMEWORKS.join(", ")}"
-      c.option '--console CONSOLE', CONSOLES, "select console: #{CONSOLES.join(", ")}"
-      c.option '--current_path [ROOT_DIR]', String, 'Path for the root folder'
+      c.syntax      = 'rdm init PATH, [options]'
+      c.description = 'generates project scaffold in passed directory'
+      c.summary     = '> ' + c.description
+      c.example     'generate scaffold with minitest', 'rdm init --test=minitest'
+      c.example     'generate scaffold with rspec',    'rdm init --test=rspec'
+      c.example     'generate scaffold with irb',      'rdm init --console=irb'
+      c.example     'generate scaffold with pry',      'rdm init --console=pry'
+      c.option      '--test FRAMEWORK', TESTFRAMEWORKS, "select test framework: #{TESTFRAMEWORKS.join(", ")}"
+      c.option      '--console CONSOLE', CONSOLES, "select console: #{CONSOLES.join(", ")}"
+      c.option      '--current_path [ROOT_DIR]', String, 'Path for the root folder'
+      
       c.action do |args, options|
+        init_dir = (args.first || `pwd`.strip)
         defaults = {
           test:         "rspec",
           console:      "irb",
-          current_path: `pwd`.strip
+          current_path: init_dir
         }
         options_hash = options.__hash__
         options_hash.delete(:trace)
@@ -42,18 +44,19 @@ class RdmCliRunner
     end
 
     command :"gen.package" do |c|
-      c.syntax = 'rdm gen.package PACKAGE_NAME [options]'
+      c.syntax      = 'rdm gen.package PACKAGE_NAME [options]'
       c.description = 'generates a package scaffold in specified folder'
-      c.summary = '> ' + c.description
-      c.example 'generate commands package',
-                  'rdm gen.package commands --path core/application/commands'
-      c.example 'generate pack/age package',
-                  'rdm gen.package pack/age --path subsystems/package'
-      c.example 'generate events package within /some/other/path folder',
-                  'rdm gen.package events --path core/domain/events --current_path /some/other/path'
-      c.example 'generate auth package without tests', 'rdm gen.package auth --path subsystems/auth'
-      c.option '--path [RELATIVE_PATH]', String, 'Path for the package'
-      c.option '--current_path [ROOT_DIR]', String, 'Path for the root folder'
+      c.summary     = '> ' + c.description
+      c.example     'generate commands package',
+                    'rdm gen.package commands --path core/application/commands'
+      c.example     'generate pack/age package',
+                    'rdm gen.package pack/age --path subsystems/package'
+      c.example     'generate events package within /some/other/path folder',
+                    'rdm gen.package events --path core/domain/events --current_path /some/other/path'
+      c.example     'generate auth package without tests', 'rdm gen.package auth --path subsystems/auth'
+      c.option      '--path [RELATIVE_PATH]', String, 'Path for the package'
+      c.option      '--current_path [ROOT_DIR]', String, 'Path for the root folder'
+      
       c.action do |args, options|
         package_name = (args.first || "")
         defaults = {
@@ -73,8 +76,9 @@ class RdmCliRunner
       c.syntax      = 'rdm git.diff REVISION'
       c.description = 'show list of modified packages from git revision'
       c.summary     = '> ' + c.description
-      c.example 'show list of modified packages from master',
-                'rdm git.diff master'
+      c.example     'show list of modified packages from master',
+                    'rdm git.diff master'
+      
       c.action do |args, options|
         revision = (args.first || "HEAD")
         options = {
@@ -86,12 +90,13 @@ class RdmCliRunner
     end
 
     command :"compile.package" do |c|
-      c.syntax = 'rdm compile.package PACKAGE_NAME [options]'
+      c.syntax      = 'rdm compile.package PACKAGE_NAME [options]'
       c.description = 'copy specified package and its dependencies to some folder'
-      c.summary = '> ' + c.description
-      c.example 'compilation of "commands" package to /tmp/commands dir',
-                'rdm compile.package commands --path /tmp/commands'
-      c.option '--path [COMPILE_PATH]', String, 'Path for compiled package'
+      c.summary     = '> ' + c.description
+      c.example     'compilation of "commands" package to /tmp/commands dir',
+                    'rdm compile.package commands --path /tmp/commands'
+      c.option      '--path [COMPILE_PATH]', String, 'Path for compiled package'
+      
       c.action do |args, options|
         package_name = (args.first || "")
         opts = {
@@ -104,13 +109,14 @@ class RdmCliRunner
     end
 
     command :"gen.template" do |c|
-      c.syntax = 'rdm gen.template TEMPLATE_NAME [options]'
+      c.syntax      = 'rdm gen.template TEMPLATE_NAME [options]'
       c.description = 'generates template from ROOT/.rdm/templates folder with specified variables'
-      c.summary = '> ' + c.description
-      c.example 'creating new repository, mapper and dao files',
-                'rdm gen.template repository --path infrastructure/storage'
-      c.option '--path [DESTINATION_PATH]', String, 'Location of generated folders'
-      c.option '--OPTION_NAME [OPTION_VALUE]', String, 'Local variables for template handler'
+      c.summary     = '> ' + c.description
+      c.example     'creating new repository, mapper and dao files',
+                    'rdm gen.template repository --path infrastructure/storage'
+      c.option      '--path [DESTINATION_PATH]', String, 'Location of generated folders'
+      c.option      '--OPTION_NAME [OPTION_VALUE]', String, 'Local variables for template handler'
+      
       c.action do |args, options|
         options_hash  = options.__hash__
         options_hash.delete(:trace)
@@ -127,10 +133,10 @@ class RdmCliRunner
     end
 
     command :"gen.deps" do |c|
-      c.syntax = 'rdm gen.deps PACKAGE_NAME'
+      c.syntax      = 'rdm gen.deps PACKAGE_NAME'
       c.description = 'puts list of recursive dependencies for specified package'
-      c.summary = '> ' + c.description
-      c.example 'show dependencies for `commands` package', 'rdm gen.deps commands'
+      c.summary     = '> ' + c.description
+      c.example     'show dependencies for `commands` package', 'rdm gen.deps commands'
 
       c.action do |args, options|
         package_name = args.first || ""
@@ -143,11 +149,11 @@ class RdmCliRunner
     end
 
     command :"gen.config" do |c|
-      c.syntax = 'rdm gen.config CONFIG_NAME --CONFIG_KEY=CONFIG_VALUE'
+      c.syntax      = 'rdm gen.config CONFIG_NAME --CONFIG_KEY=CONFIG_VALUE'
       c.description = 'generate config file with passed arguments'
-      c.summary = '> ' + c.description
-      c.example 'generate config `mailing_system` with `host: localhost`', 
-                'rdm gen.config mailing_system --host=localhost'
+      c.summary     = '> ' + c.description
+      c.example     'generate config `mailing_system` with `host: localhost`', 
+                    'rdm gen.config mailing_system --host=localhost'
       
       c.action do |args, options|
         config_name  = args.first || ""
@@ -161,6 +167,60 @@ class RdmCliRunner
         )
       end
     end
+    
+    command :"rspec.run" do |c|
+      c.syntax      = 'rdm rspec.run PACKAGE_NAME SPEC_MATCHER'
+      c.description = 'run tests for specified package and spec file matcher'
+      c.summary     = '> ' + c.description
+
+      c.example     'run tests for all packages',
+                    'rdm rspec.run'
+      c.example     'run tests for `mailing_system` package',
+                    'rdm rspec.run mailing_system'
+      c.example     'run tests for `mailing_system` package and files, matches `events` string',
+                    'rdm rspec.run mailing_system events'
+      
+      c.action do |args, options|
+        package_name = args[0]
+        spec_matcher = args[1]
+
+        ENV['RUBY_ENV'] = 'test'
+
+        Rdm.root(`pwd`.chomp)
+        Rdm::SpecRunner.run(
+          package:          package_name,
+          spec_matcher:     spec_matcher,
+          path:             `pwd`.chomp,
+          skip_ignored_packages: true,
+          show_missing_packages: true
+        )
+      end
+    end
+
+    command :"rspec.diff_run" do |c|
+      c.syntax      = 'rdm rspec.diff_run REVISION'
+      c.description = 'run tests for modified packages from specified git revision'
+      c.summary     = '> ' + c.description
+
+      c.example     'run tests for packages modified from HEAD',
+                    'rdm rspec.diff_run'
+      c.example     'run tests for packages modified from commit by hash',
+                    'rdm rspec.diff_run a7rrey'
+      c.example     'run tests for packages modified from specified branch',
+                    'rdm rspec.diff_run master'
+      
+      c.action do |args, options|
+        revision = args[0]
+
+        ENV['RUBY_ENV'] = 'test'
+        Rdm.root(`pwd`.chomp)
+
+        Rdm::CLI::DiffSpecRunner.run(
+          revision: revision,
+          path:     `pwd`.chomp
+        )
+      end
+    end
 
     run!
   end

data/example/.rdm/templates/configs/<%=config_path%>

@@ -0,0 +1,2 @@
+<%=config_name%>:
+  <%=config_locals%>

data/example/.rdm/templates/configs/<%=role_config_path%>

@@ -0,0 +1,2 @@
+<%=config_name%>:
+  <%=config_locals%>

data/example/Rdm.packages

@@ -1,7 +1,12 @@
 setup do
-  role "production"
-  
-  env_file_name "production"
+  role do
+    ENV['RUBY_ENV'] || "production"
+  end
+
+  env_file_name do
+    ENV['ENV_FILE'] || "production"
+  end
+
   env_files_dir "env_files"
 
   configs_dir "configs"

data/example/domain/core/spec/core/one_more_spec.rb

@@ -0,0 +1,5 @@
+describe 'It works' do
+  it "works" do
+    expect(2).to eq 2
+  end
+end

data/example/domain/core/spec/core/sample_service_spec.rb

@@ -0,0 +1,5 @@
+describe 'It works' do
+  it "works" do
+    expect(2).to eq 2
+  end
+end

data/example/infrastructure/repository/Package.rb

@@ -4,6 +4,6 @@ package do
 end
 
 dependency do
-  require "sequel"
+  # require "sequel"
   import_config :app
 end

data/example/infrastructure/repository/spec/example_spec.rb

@@ -0,0 +1,5 @@
+describe 'It works' do
+  it "works" do
+    File.open('fixture.txt', 'w') {|f| f.write('Repository spec working here!')} 
+  end
+end

data/example/infrastructure/repository/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rdm'
+Rdm.init(File.expand_path('../../', __FILE__), :test)
+
+require 'rspec'
+
+RSpec.configure do |config|
+end

data/example/server/spec/server_spec.rb

@@ -0,0 +1,5 @@
+describe 'It works' do
+  it "works" do
+    expect(2).to eq(2)
+  end
+end

data/example/server/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rdm'
+Rdm.init(File.expand_path('../../', __FILE__), :test)
+
+require 'rspec'
+
+RSpec.configure do |config|
+end

data/example/tests/diff_run

@@ -1,32 +1,3 @@
 #!/usr/bin/env ruby
 
-ENV['RUBY_ENV'] = 'test'
-require 'rdm'
-
-REVISION = ARGV.clone.first
-PATH     = File.expand_path(__FILE__)
-
-begin
-  changed_packages = Rdm::Handlers::DiffPackageHandler.handle(
-    path:     PATH, 
-    revision: REVISION
-  )
-
-  puts "Tests for the following packages will run:"
-  puts changed_packages
-
-  changed_packages.each do |package| 
-    Rdm::SpecRunner.run(
-      package:               package,
-      path:                  PATH,
-      show_missing_packages: false
-    )
-  end
-  
-
-rescue Rdm::Errors::GitRepositoryNotInitialized
-  puts "Git repository is not initialized. Use `git init .`"
-  exit(1)
-end
-
-
+system("bundle exec rdm rspec.diff_run #{ARGV.join(' ')}", out: STDOUT, err: :out)

data/example/tests/run

@@ -1,41 +1,3 @@
 #!/usr/bin/env ruby
 
-## # run own tests:
-## $ TEST_RUN=1 tests/run
-
-## # run application tests:
-## $ tests/run
-
-## # run package tests:
-## $ tests/run commands
-
-## # run spec in a package:
-## $ tests/run commands some_spec.rb
-
-ENV['RUBY_ENV'] = 'test'
-require 'rdm'
-
-Rdm.root(__FILE__)
-
-if ENV['TEST_RUN']
-  require 'minitest/autorun'
-  describe Rdm::SpecRunner::Runner do
-    before do
-      @runner = Rdm::SpecRunner::Runner.new({})
-    end
-
-    describe 'works ' do
-      it 'assert true' do
-        assert 2 == 2
-      end
-    end
-  end
-else
-  Rdm::SpecRunner.run(
-    package:          ARGV.clone.first,
-    spec_matcher:     ARGV.clone[1],
-    path:             File.expand_path(__FILE__),
-    skip_ignored_packages: true,
-    show_missing_packages: true
-  )
-end
+system("bundle exec rdm rspec.run #{ARGV.join(' ')}", out: STDOUT, err: :out)