rigit 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9225e47cd4053ff2b58617293897271b9336f625e705de83b00c27bd0ee62035
-  data.tar.gz: 378721971c76ee5acc9e2bb0d056112e09b131d2bff464fa63b84c5f6b8c2278
+  metadata.gz: 55f146cc6a111bbb185a681203d87a7cf5092ce5f461e3e1aac4aec11bd121aa
+  data.tar.gz: 46990712e2b86bd1b1c8785084d6e1b02e18f05de2248030a41e21ec8b7049b8
 SHA512:
-  metadata.gz: bcdf50376677c22d94ba59b73a85ef87c378fac414fe4469faa55cd2fee44b1ac5644179c0be4913a1f205d6c79cb5ec2cc0426d6cd55e90144c4d112a462b6f
-  data.tar.gz: bdb7363fc79e942b5b8299d94da698e1af724420363cef5b76bef4068887f1ccc16b58d8ca124f9219c95111e337db7de7da0f8a87e163c9fdf512dd7c917346
+  metadata.gz: 8f33dbd202c77428e16e05bf42441b6359b49132ef78a977608d13029414327441c163e44e390957fb5182fc7554948e86ef359b4598daa4d794d8726280c5e2
+  data.tar.gz: 84f92225b7b0edeba9a5a4583a097ccac9047dc5e2b1fe837bd19be45ecf4f08c5be5d96e93530d3bf21be282613eb97d8117e49d01ba7552eed537a1ab670db

data/README.md

@@ -0,0 +1,49 @@
+Rigit
+==================================================
+
+[![Gem](https://img.shields.io/gem/v/rigit.svg?style=flat-square)](https://rubygems.org/gems/rigit)
+[![Build](https://img.shields.io/travis/DannyBen/rigit.svg?style=flat-square)](https://travis-ci.org/DannyBen/rigit)
+[![Maintainability](https://img.shields.io/codeclimate/maintainability/DannyBen/rigit.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/rigit)
+[![Issues](https://img.shields.io/codeclimate/issues/github/DannyBen/rigit.svg?style=flat-square)](https://codeclimate.com/github/DannyBen/rigit)
+
+---
+
+![Rigit](rigit-header.png)
+
+---
+
+Table of Contents
+--------------------------------------------------
+
+* [Installation](#installation)
+* [Quick Start](#quick-start)
+* [Installing Rigs](#installing-rigs)
+* [Using Rigs (Scaffolding)](#using-rigs-scaffolding)
+* [Creating Rigs](#creating-rigs)
+   * [Directory Structure](#directory-structure)
+   * [Config File](#config-file)
+
+
+Installation
+--------------------------------------------------
+
+
+Quick Start
+--------------------------------------------------
+
+
+Installing Rigs
+--------------------------------------------------
+
+
+Using Rigs (Scaffolding)
+--------------------------------------------------
+
+
+Creating Rigs
+--------------------------------------------------
+
+### Directory Structure
+
+### Config File
+

data/bin/rig

@@ -1,15 +1,18 @@
 #!/usr/bin/env ruby
 require 'rigit'
+require 'colsole'
+include Colsole
 
 begin
   Rigit::CommandLine.execute ARGV
 rescue Rigit::Exit => e
-  puts e.message
+  message = e.message
+  say message unless message == 'Rigit::Exit'
   exit 1
 rescue Rigit::ConfigError => e
-  puts "#{e.class} - #{e.message}"
+  say "#{e.class} - #{e.message}"
   exit 1
 rescue TTY::Reader::InputInterrupt
-  puts "\nGoodbye"
+  say "\nGoodbye"
   exit 1
 end

data/lib/rigit/command_line.rb

@@ -5,8 +5,9 @@ module Rigit
   class CommandLine < SuperDocopt::Base
     version VERSION
     docopt File.expand_path 'docopt.txt', __dir__
-    subcommands [:build]
+    subcommands [:build, :install]
 
     include Commands::Build
+    include Commands::Install
   end
 end

data/lib/rigit/commands/build.rb

@@ -1,81 +1,77 @@
-require 'super_docopt'
+require 'colsole'
 
-module Rigit
-  module Commands
-    module Build
-      def build
-        Builder.new(args).execute
-      end
-
-      class Builder
-        attr_reader :args
+module Rigit::Commands
+  module Build
+    def build
+      Builder.new(args).execute
+    end
 
-        def initialize(args)
-          @args = args
-        end
+    class Builder
+      attr_reader :args, :rig_name, :target_dir
 
-        def execute
-          puts "#{config.intro}\n\n" if config.intro
-          verify_folders
-          arguments = prompt.get_input params
-          rigger = Rigit::Rigger.new source, arguments
-          rigger.scaffold
-        end
+      include Colsole
 
-        private
+      def initialize(args)
+        @args = args
+        @rig_name = args['RIG']
+        @target_dir = '.'
+      end
 
-        def config
-          @config ||= config_for source
-        end
+      def execute
+        say "Building !txtgrn!#{rig_name}"
+        say "!txtblu!#{config.intro}" if config.has_key? :intro
+        verify_dirs
+        arguments = prompt.get_input params
+        rig.scaffold arguments:arguments, target_dir: target_dir
+        say "Done"
+      end
 
-        def source
-          args['RIG']
-        end
+      private
 
-        def target_dir
-          '.'
-        end
+      def rig
+        @rig ||= Rigit::Rig.new rig_name
+      end
 
-        def source_dir
-          "#{ENV['RIG_HOME']}/#{source}"
-        end
+      def config
+        @config ||= rig.config
+      end
 
-        def params
-          @params ||= params!
-        end
+      def params
+        @params ||= params!
+      end
 
-        def params!
-          output = {}
-          input = args['PARAMS']
-          input.each do |param|
-            key, value = param.split '='
-            output[key.to_sym] = value
-          end
-          output
+      def params!
+        output = {}
+        input = args['PARAMS']
+        input.each do |param|
+          key, value = param.split '='
+          output[key.to_sym] = value
         end
+        output
+      end
 
-        def prompt
-          @prompt ||= Rigit::Prompt.new config.params
-        end
+      def prompt
+        @prompt ||= Rigit::Prompt.new config.params
+      end
 
-        def tty_prompt
-          @tty_prompt ||= TTY::Prompt.new
-        end
+      def tty_prompt
+        @tty_prompt ||= TTY::Prompt.new
+      end
 
-        def config_for(source)
-          Rigit::Config.load("#{ENV['RIG_HOME']}/#{source}/config.yml")
-        end
+      def verify_dirs
+        verify_source_dir
+        verify_target_dir
+      end
 
-        def verify_folders
-          if !Dir.exist? source_dir
-            raise Rigit::Exit, "No such rig: #{source}"
-          end
+      def verify_source_dir
+        raise Rigit::Exit, "No such rig: #{rig_name}" unless rig.exist?
+      end
 
-          if !Dir.empty? target_dir
-            dirstring = target_dir == '.' ? 'Current directory' : "Directory '#{target_dir}'"
-            continue = tty_prompt.yes? "#{dirstring} is not empty. Continue anyway?", default: false
-            raise Rigit::Exit, "Goodbye" unless continue
-          end
+      def verify_target_dir
+        if !Dir.empty? target_dir
+          dirstring = target_dir == '.' ? 'Current directory' : "Directory '#{target_dir}'"
+          continue = tty_prompt.yes? "#{dirstring} is not empty. Continue anyway?", default: false
+          raise Rigit::Exit, "Goodbye" unless continue
         end
       end
     end

data/lib/rigit/commands/install.rb

@@ -0,0 +1,58 @@
+require 'fileutils'
+require 'colsole'
+
+module Rigit::Commands
+  module Install
+    def install
+      Installer.new(args).execute
+    end
+
+    class Installer
+      include Colsole
+
+      attr_reader :args, :rig_name, :repo
+
+      def initialize(args)
+        @args = args
+        @rig_name = args['RIG']
+        @repo = args['REPO']
+      end
+
+      def execute
+        verify_dirs
+        install
+      end
+
+      private
+
+      def install
+        say "Installing !txtgrn!#{repo}\n"
+        FileUtils.mkdir_p target_path unless Dir.exist? target_path
+        success = Git.clone repo, target_path
+
+        if success
+          say "\nRig installed !txtgrn!successfully!txtrst! in !txtgrn!#{target_path}"
+          say "To build a new project with this rig, run this in any empty directory:\n"
+          say "  !txtpur!rig build #{rig_name}\n"
+        end
+      end
+
+      def rig
+        @rig ||= Rigit::Rig.new rig_name
+      end
+
+      def target_path
+        @target_path ||= rig.path
+      end
+
+      def verify_dirs
+        if Dir.exist? target_path
+          say "Rig !txtgrn!#{rig_name}!txtrst! is already installed."
+          say "In order to update it from the source repository, run:\n"
+          say "  !txtpur!rig update #{rig_name}\n"
+          raise Rigit::Exit
+        end
+      end
+    end
+  end
+end

data/lib/rigit/config.rb

@@ -19,7 +19,7 @@ module Rigit
 
     def settings!
       settings = Configatron::RootStore.new
-      settings.configure_from_hash YAML.load_file(path)
+      settings.configure_from_hash YAML.load_file(path) if File.exist? path
       settings
     end
   end

data/lib/rigit/docopt.txt

@@ -2,10 +2,28 @@ Rigit
 
 Usage:
   rig build RIG [PARAMS...]
+  rig install RIG REPO
+
+Commands:
+  build
+    Create a new project based on one of the installed rig templates.
+    This command should be executed in an empty directory.
+    In case the rig has arguments, you will be prompted to input them.
+    If you wish to execute this command without interactivity, you may
+    use specify all parameters in the PARAMS parameter (see below).
 
 Parameters:
   RIG
     The name of the source folder (installed rig).
 
+  REPO
+    A git repository containing rig configuration. 
+    Use the 'clone URL' for the repository.
+
+  PARAMS
+    Specify any of the rig's parameters in the format 'param=value'.
+    For boolean parameters, use 'param=y' or 'param=n'.
+
 Examples:
-  rig build gem name=mygem
+  rig build gem name=mygem spec=y
+  rig install example https://github.com/DannyBen/example-rig.git

data/lib/rigit/extensions/file_extension.rb

@@ -2,9 +2,12 @@ require 'fileutils'
 
 class File
   def self.deep_write(filename, content)
+    # :nocov: only due to the fact that the rspec_fixtures gem brings
+    #         this method as well
     dirname = File.dirname filename
     FileUtils.mkdir_p dirname unless File.directory? dirname
     File.write filename, content
+    # :nocov:
   end
 end
 

data/lib/rigit/git.rb

@@ -0,0 +1,19 @@
+module Rigit
+  class Git
+    def self.clone(repo, target_path)
+      execute %Q[git clone #{repo} "#{target_path}"]
+    end
+
+    private
+
+    def self.execute(command)
+      if ENV['SIMULATE_GIT']
+        puts "Simulated Execute: #{command}"
+        true
+      else
+        system command
+        $?&.exitstatus == 0
+      end
+    end
+  end
+end

data/lib/rigit/rig.rb

@@ -0,0 +1,56 @@
+module Rigit
+  class Rig
+    attr_reader :name
+
+    def self.home
+      ENV['RIG_HOME'] ||= File.expand_path('.rigs', Dir.home)
+    end
+
+    def self.home=(path)
+      ENV['RIG_HOME'] = path
+    end
+
+    def initialize(name)
+      @name = name
+    end
+
+    def scaffold(arguments: {}, target_dir:'.')
+      scaffold_dir "#{path}/base", arguments, target_dir
+
+      arguments.each do |key, value| 
+        additive_dir = "#{path}/#{key}=#{value}"
+        if Dir.exist? additive_dir
+          scaffold_dir additive_dir, arguments, target_dir
+        end
+      end
+    end
+
+    def path
+      "#{Rig.home}/#{name}"
+    end
+
+    def exist?
+      Dir.exist? path
+    end
+
+    def config_file
+      "#{path}/config.yml"
+    end
+
+    def config
+      @config ||= Config.load(config_file)
+    end
+
+    private
+
+    def scaffold_dir(dir, arguments, target_dir)
+      files = Dir["#{dir}/**/*"].reject { |file| File.directory? file }
+
+      files.each do |file|
+        target_file = (file % arguments).sub dir, target_dir
+        content = File.read(file) % arguments
+        File.deep_write target_file, content
+      end
+    end
+  end
+end

data/lib/rigit/version.rb

@@ -1,3 +1,3 @@
 module Rigit
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/rigit.rb

@@ -1,11 +1,16 @@
 require 'rigit/extensions/file_extension.rb'
 
-require 'rigit/commands/build'
-
-require 'rigit/command_line'
 require 'rigit/config'
 require 'rigit/errors'
 require 'rigit/prompt'
-require 'rigit/rigger'
+require 'rigit/rig'
+require 'rigit/git'
+
+require 'rigit/commands/build'
+require 'rigit/commands/install'
+require 'rigit/command_line'
 
-ENV['RIG_HOME'] ||= File.expand_path('.rigs', Dir.home)
+module Rigit
+  module Commands
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rigit
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Danny Ben Shitrit
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: colsole
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -171,16 +185,19 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- README.md
 - bin/rig
 - lib/rigit.rb
 - lib/rigit/command_line.rb
 - lib/rigit/commands/build.rb
+- lib/rigit/commands/install.rb
 - lib/rigit/config.rb
 - lib/rigit/docopt.txt
 - lib/rigit/errors.rb
 - lib/rigit/extensions/file_extension.rb
+- lib/rigit/git.rb
 - lib/rigit/prompt.rb
-- lib/rigit/rigger.rb
+- lib/rigit/rig.rb
 - lib/rigit/version.rb
 homepage: https://github.com/DannyBen/rigit
 licenses:

data/lib/rigit/rigger.rb

@@ -1,38 +0,0 @@
-module Rigit
-  class Rigger
-    attr_reader :rig, :arguments, :target_dir
-
-    def initialize(rig, arguments={}, target_dir='.')
-      @rig = rig
-      @target_dir = target_dir
-      @arguments = arguments
-    end
-
-    def scaffold
-      scaffold_dir "#{source_dir}/base"
-
-      arguments.each do |key, value| 
-        additive_dir = "#{source_dir}/#{key}=#{value}"
-        if Dir.exist? additive_dir
-          scaffold_dir additive_dir
-        end
-      end
-    end
-
-    private
-
-    def source_dir
-      "#{ENV['RIG_HOME']}/#{rig}"
-    end
-
-    def scaffold_dir(dir)
-      files = Dir["#{dir}/**/*"].reject { |file| File.directory? file }
-
-      files.each do |file|
-        target_file = (file % arguments).sub dir, target_dir
-        content = File.read(file) % arguments
-        File.deep_write target_file, content
-      end
-    end
-  end
-end