rdm 0.1.12 → 0.1.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 66772ce18f205894e338d4488a739f64251fc1a7
-  data.tar.gz: 787ec81e2d74245cb9c7e8344da6638e4a27a731
+  metadata.gz: 8dcb5bace74354caa9f02899805e8cffce5781fc
+  data.tar.gz: 3421a86c4e1b8f140fea4b9039b5800349fdb5f0
 SHA512:
-  metadata.gz: e14981c363eb19b7c2bd57feaa3af786421821db7872d266132929d70e9555475a9a06d8cd385a9bee808191ab2422d48070c9bdcade6fff0f3c64e7dca9615e
-  data.tar.gz: c3525e1e6ad865d092fe46dab42b7e676864c6e4e8455d861b98f0eaccda2321eaadbba0f233c712efa76dbae70bfb3afdd788a9269ccfb7c310dd0fcb496538
+  metadata.gz: 4f73c1caa72e08ce36dbd8fea7890aba454464d513a7494d5f9e47dabbe0149eb66feaa2d756e127cf2c2dc999e55664112a79870e872723b820254bf9941d7b
+  data.tar.gz: d6c4e38225c564ffe46751bfdb8ad1c434377d9a41a95bb19b3755b460f2d0e081efced32d304fc1973d20024c8c4f4ae73cb522800745787666387199933713

data/.gitignore

@@ -1,4 +1,6 @@
 .DS_Store
 Gemfile.lock
 Package.rb.lock
-pkg
+pkg
+coverage/
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,17 @@
+AllCops:
+  Exclude:
+    - 'lib/rdm/templates/**/**/*'
+
+Style/Documentation:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/DocumentationMethod:
+  Enabled: false
+  RequireForNonPublicMethods: false
+
+
+Metrics/LineLength:
+   Max: 90

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+rvm:
+  - 2.2.2
+  - 2.3.0
+  - 2.4.0
+
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install bundler
+
+script:
+  - bundle exec rspec

data/Gemfile

@@ -1,3 +1,7 @@
 source 'https://rubygems.org'
 
-gemspec
+gemspec
+
+group :test do
+  gem "rubocop", "~> 0.46"
+end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2016 Droidlabs
+Copyright (c) 2016-2017 Droidlabs
 
 MIT License
 

data/README.md

@@ -1,42 +1,98 @@
-### RDM (Ruby Dependecy Manager)
+# Rdm (Ruby Dependecy Manager)
+[![Build Status](https://travis-ci.org/ddd-ruby/rdm.png)](https://travis-ci.org/ddd-ruby/rdm)
+[![Code Climate](https://codeclimate.com/github/ddd-ruby/rdm/badges/gpa.svg)](https://codeclimate.com/github/ddd-ruby/rdm)
+[![codecov](https://codecov.io/gh/ddd-ruby/rdm/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/rdm)
+[![Dependency Status](https://gemnasium.com/ddd-ruby/rdm.png)](https://gemnasium.com/ddd-ruby/rdm)
+
 
 Ruby dependency manager, helps managing local package dependencies.
 See sample application in "example" folder.
 
 
 ## Setup
-1. create Rdm.packages in the root dir of your application
-    ```ruby
-      setup do
-        role                ENV['RUBY_ENV'] || 'production'
-        configs_dir         'configs'
-        config_path         ":configs_dir/:config_name/default.yml"
-        role_config_path    ":configs_dir/:config_name/:role.yml"
-        package_subdir_name 'package'
-      end
+You can initialize a project with `rdm`:
+
+    $ mkdir my_project && rdm init
+
+Alternatively you could manually create the an `Rdm.packages` file with similar content in your existing project:
+
+```ruby
+setup do
+  role                ENV['RUBY_ENV'] || 'production'
+  configs_dir         'configs'
+  config_path         ":configs_dir/:config_name/default.yml"
+  role_config_path    ":configs_dir/:config_name/:role.yml"
+  package_subdir_name 'package'
+end
+
+config :database
+config :app
+
+package 'server'
+package 'application/web'
+package 'domain/core'
+package 'infrastructure/repository'
+```
+
+
+## Generating new packages
+
+    # see available options
+    $ rdm gen.package -h
+
+    # generate commands package in a relative path to root directory
+    $ rdm gen.package commands --path core/application/commands
+
+
+## Example Package.rb
+
+```ruby
+package do
+  name    'system_bus'
+  version '1.0.0'
+end
+
+dependency do
+  import 'utils'
+end
+
+dependency :test do
+  import 'repository'
+  import 'database'
+  import 'events'
+end
+```
+
+
+## Rough Idea
+
+`Rdm` positions itself somewhere between Ruby gems and Rails engines. It allows you to define clear boundaries in your application by splitting it up in application-level, framework-agnostic packages. Each package defines in its `Package.rb` file clear dependencies on other packages / gems for each environment.
+
+When you `boot` a package (eg. by loading it in IRB), only defined dependencies are available to you. This is done by letting `Rdm` manage the Ruby-`$LOAD_PATH` behind the scenes for you.
+
+All packages share the same Gemfile, but get access to only explicitly defined subset of gems / packages from the `Package.rb` file
+
+When needed you can ask `Rdm` to programmatically give you dependencies for a particular package and use it. At `DroidLabs` we use this to generate very lightweight Dockerimages with just the necessary dependencies for each application.
+
+
+## Rules of RDM to structure big Ruby applications
+
+- define all your gems in `Gemfile` to be __lazily__ loaded, like `gem 'sequel', '4.41.0', require: false`
+- name your classes / modules after Rails-established conventions, so files are loaded only on demand, when encountering a new class / module constant (const_missing from ActiveSupport)
 
-      config :database
-      config :app
+- use a Dependency Injection library with lazy-loading support, we recommend `smart_ioc`
 
-      package 'server'
-      package 'application/web'
-      package 'domain/core'
-      package 'infrastructure/repository'
-    ```
 
-1. Use package generator to create new package
+## Loading `Rdm`
 
-    ```ruby
-      rdm-generate package server --path=core/server
-    ```
+Setup RDM in boot.rb or spec_helper.rb or any other initializer. Rdm.init should point to a directory with `Package.rb`-file
 
-1. Setup RDM in boot.rb or spec_helper.rb or any other initializer. Rdm.init should point to the directory where Rdm.packages file is located
+```ruby
+require 'rdm'
+Rdm.init(File.expand_path("../../", __FILE__), :test)
+```
 
-    ```ruby
-      require 'rdm'
-      Rdm.init(File.expand_path("../../", __FILE__), :test)
-    ```
 
-1. Run rdm-install in root directory to create Package.rb.lock for each package. You should do that each time you create new package or update existing package dependencies.
+## Examples
 
-1. Go to package directory, create some tests and run them.
+- [small dummy application](/example)

data/bin/rdm

@@ -0,0 +1,72 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+require 'rubygems'
+require 'bundler/setup'
+require 'commander'
+require 'rdm'
+
+class RdmCliRunner
+  TESTFRAMEWORKS = %w[minitest rspec]
+  CONSOLES       = %w[irb pry]
+  include Commander::Methods
+
+  def run
+    program :name, 'RDM'
+    program :version, Rdm::VERSION
+    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_dir [ROOT_DIR]', String, 'Path for the root folder'
+      c.action do |args, options|
+        defaults = {
+          test:        "rspec",
+          console:     "irb",
+          current_dir: `pwd`.strip
+        }
+        options_with_defaults = defaults.merge!(options.__hash__)
+        Rdm::CLI::Init.run(options_with_defaults)
+      end
+    end
+
+    command :"gen.package" do |c|
+      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_dir /some/other/path'
+      c.example 'generate auth package without tests', 'rdm gen.package auth --path subsystems/auth --skip-tests'
+      c.option '--path [RELATIVE_PATH]', String, 'Path for the package'
+      c.option '--current_dir [ROOT_DIR]', String, 'Path for the root folder'
+      c.option '--skip-test', '--skip-tests', 'Don\'t generate test files'
+      c.action do |args, options|
+        package_name = (args.first || "")
+        defaults = {
+          skip_tests:   false,
+          current_dir:  `pwd`.chomp,
+          package_name: package_name,
+          path:         package_name.downcase.gsub(/\s+/, '_')
+        }
+        options_with_defaults = defaults.merge!(options.__hash__)
+        Rdm::CLI::GenPackage.run(options_with_defaults)
+      end
+    end
+
+    run!
+  end
+end
+
+RdmCliRunner.new.run

data/bin/rubocop

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+if RUBY_VERSION.to_f > 2.1
+  puts "running rubocop..."
+  exec("bundle exec rubocop -a -D lib/")
+end

data/docs/_config.yml

@@ -0,0 +1 @@
+theme: jekyll-theme-minimal

data/docs/index.md

@@ -0,0 +1,98 @@
+# Rdm (Ruby Dependecy Manager)
+[![Build Status](https://travis-ci.org/ddd-ruby/rdm.png)](https://travis-ci.org/ddd-ruby/rdm)
+[![Code Climate](https://codeclimate.com/github/ddd-ruby/rdm/badges/gpa.svg)](https://codeclimate.com/github/ddd-ruby/rdm)
+[![codecov](https://codecov.io/gh/ddd-ruby/rdm/branch/master/graph/badge.svg)](https://codecov.io/gh/ddd-ruby/rdm)
+[![Dependency Status](https://gemnasium.com/ddd-ruby/rdm.png)](https://gemnasium.com/ddd-ruby/rdm)
+
+
+Ruby dependency manager, helps managing local package dependencies.
+See sample application in "example" folder.
+
+
+## Setup
+You can initialize a project with `rdm`:
+
+    $ mkdir my_project && rdm init
+
+Alternatively you could manually create the an `Rdm.packages` file with similar content in your existing project:
+
+```ruby
+setup do
+  role                ENV['RUBY_ENV'] || 'production'
+  configs_dir         'configs'
+  config_path         ":configs_dir/:config_name/default.yml"
+  role_config_path    ":configs_dir/:config_name/:role.yml"
+  package_subdir_name 'package'
+end
+
+config :database
+config :app
+
+package 'server'
+package 'application/web'
+package 'domain/core'
+package 'infrastructure/repository'
+```
+
+
+## Generating new packages
+
+    # see available options
+    $ rdm gen.package -h
+
+    # generate commands package in a relative path to root directory
+    $ rdm gen.package commands --path core/application/commands
+
+
+## Example Package.rb
+
+```ruby
+package do
+  name    'system_bus'
+  version '1.0.0'
+end
+
+dependency do
+  import 'utils'
+end
+
+dependency :test do
+  import 'repository'
+  import 'database'
+  import 'events'
+end
+```
+
+
+## Rough Idea
+
+`Rdm` positions itself somewhere between Ruby gems and Rails engines. It allows you to define clear boundaries in your application by splitting it up in application-level, framework-agnostic packages. Each package defines in its `Package.rb` file clear dependencies on other packages / gems for each environment.
+
+When you `boot` a package (eg. by loading it in IRB), only defined dependencies are available to you. This is done by letting `Rdm` manage the Ruby-`$LOAD_PATH` behind the scenes for you.
+
+All packages share the same Gemfile, but get access to only explicitly defined subset of gems / packages from the `Package.rb` file
+
+When needed you can ask `Rdm` to programmatically give you dependencies for a particular package and use it. At `DroidLabs` we use this to generate very lightweight Dockerimages with just the necessary dependencies for each application.
+
+
+## Rules of RDM to structure big Ruby applications
+
+- define all your gems in `Gemfile` to be __lazily__ loaded, like `gem 'sequel', '4.41.0', require: false`
+- name your classes / modules after Rails-established conventions, so files are loaded only on demand, when encountering a new class / module constant (const_missing from ActiveSupport)
+
+- use a Dependency Injection library with lazy-loading support, we recommend `smart_ioc`
+
+
+## Loading `Rdm`
+
+Setup RDM in boot.rb or spec_helper.rb or any other initializer. Rdm.init should point to a directory with `Package.rb`-file
+
+```ruby
+require 'rdm'
+Rdm.init(File.expand_path("../../", __FILE__), :test)
+```
+
+
+## Examples
+
+- [small dummy application](/example)

data/docs/interface_brainstorming.md

@@ -0,0 +1,31 @@
+### possible CLI interface for RDM
+
+rdm init --test=minitest
+rdm init --test=rspec
+
+rdm init --console=irb
+rdm init --console=pry
+
+rdm gen.package some_package --path subsystems/some_package
+
+rdm --version
+rdm -v
+
+rdm --help
+rdm -h
+
+
+
+### RDM public API:
+
+
+Rdm.init("some/Package.rb")
+Rdm.init("some/Package.rb", :test)
+
+
+
+# Rdm::SourceParser.read_and_init_source(rdm_packages_path).packages
+
+Rdm.source
+# instance of Rdm::Source
+Rdm.packages

data/example/Rdm.packages

@@ -12,4 +12,4 @@ config :app
 package "server"
 package "application/web"
 package "domain/core"
-package "infrastructure/repository"
+package "infrastructure/repository"

data/example/Readme.md

@@ -1,5 +1,3 @@
-### Lock all package dependencies
-    $ bundle exec rdm-install
-
 ### Run server:
+    $ bundle
     $ bundle exec ruby server/server.rb

data/lib/rdm.rb

@@ -1,21 +1,32 @@
 module Rdm
-  SOURCE_FILENAME = "Rdm.packages"
-  PACKAGE_FILENAME = "Package.rb"
-  PACKAGE_LOCK_FILENAME = "#{PACKAGE_FILENAME}.lock"
-
-  require "rdm/errors"
-  require "rdm/settings"
-  require "rdm/source"
-  require "rdm/source_parser"
-  require "rdm/source_installer"
-  require "rdm/package"
-  require "rdm/package_parser"
-  require "rdm/package_generator"
-  require "rdm/package_importer"
-  require "rdm/config"
-  require "rdm/config_scope"
-  require "rdm/config_manager"
-  require "rdm/auto_updater"
+  SOURCE_FILENAME = 'Rdm.packages'.freeze
+  PACKAGE_FILENAME = 'Package.rb'.freeze
+
+  # Utils
+  require 'rdm/support/colorize'
+  require 'rdm/support/render'
+  require 'rdm/support/template'
+  require 'rdm/version'
+
+  # CLI part
+  require 'rdm/cli/gen_package'
+  require 'rdm/cli/init'
+  require 'rdm/gen/concerns/template_handling'
+  require 'rdm/gen/package'
+  require 'rdm/gen/init'
+
+  # Runtime part
+  require 'rdm/config'
+  require 'rdm/config_scope'
+  require 'rdm/config_manager'
+  require 'rdm/errors'
+  require 'rdm/package'
+  require 'rdm/package_parser'
+  require 'rdm/package_importer'
+  require 'rdm/settings'
+  require 'rdm/source'
+  require 'rdm/source_parser'
+  require 'rdm/source_locator'
 
   class << self
     # Initialize current package using Package.rb
@@ -45,8 +56,6 @@ module Rdm
       @root = value
     end
 
-    def root
-      @root
-    end
+    attr_reader :root
   end
 end