rails-dev-tools 1.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8521d4f1cf1ae2731589db49050da30beb1b71b857cb47ae132f7c62be024af5
+  data.tar.gz: e6f4994b5adcd9ab50e043b2c348b58af9ae5ba837e78bff2503454d7fe40a0f
+SHA512:
+  metadata.gz: aae21b0b0c2df5aa30e51e3beadeb801a233d3311ea36806b4dedc8680131f28a19872a01d2fe1b976b32242564ee9a52d4bccad059983cd08642861cdda8a16
+  data.tar.gz: 550f75d96be2edb8003d97ad4fec13a392e09e32e6ca1e5caccb377e393f78480fc09ca7704cda0b0e014ad3eba917a04e23847c439926fdecd3c1995245a8d8

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Francesco Ballardin
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,109 @@
+# Dev
+This gem installs an executable command named `dev` which aims to help you develop and maintain Ruby or Ruby on Rails projects.
+
+This gem takes inspiration from the Git Workflow published on [this page](https://nvie.com/posts/a-successful-git-branching-model/).
+
+This gem can be used with mini Ruby projects composed of just one directory and a few files and at the same time with big Rails projects with many main apps and engines.
+
+To work with big project, it is assumed that you organized your folders as follows:
+
+```bash
+/path/to/project/                     # Main project directory
+/path/to/project/main_apps            # Main apps directory
+/path/to/project/main_apps/app1       # Main app 1
+/path/to/project/main_apps/app2       # Main app 2
+...
+/path/to/project/engines              # Engines directory
+/path/to/project/engines/engine1      # Engine 1
+/path/to/project/engines/engine2      # Engine 2
+...
+```
+
+## Installation
+Install with:
+```bash
+$ gem install rails-dev-tools
+```
+
+This will install an executable command named `dev`.
+
+## Usage
+From the shell run:
+```
+$ dev help
+```
+
+To list all the available commands.
+
+## Commands
+
+Usual git commands are `pull` and `push`. If you have a big project, this helps you pulling and pushing without moving from the current directory.
+
+### Pull
+
+To pull data for a specific main app or engine:
+
+```bash
+dev pull app1
+dev pull engine2
+```
+
+To pull data for all main apps and engines:
+```
+dev pull
+```
+
+### Push
+
+To push data for a specific main app or engine:
+
+```bash
+dev push app1 "commit message"
+dev push engine2 "commit message"
+```
+
+### Feature
+
+If you want to start developing a new feature:
+```bash
+dev feature open my-new-feat
+```
+
+You will be placed on a new branch called `feature/my-new-feat`. Do all your work and then push it. After that, you can close your feature with:
+```bash
+dev feature close my-new-feat
+```
+
+This will merge the feature branch on the `develop` branch.
+
+### Release
+
+When all your work into the develop branch is ready to become a new release, run:
+
+```bash
+dev release open 0.2.0
+```
+
+You will be placed on a new branch called `release/0.2.0`. You can work on this branch until it becomes stable and passes all tests. At this point commit and push your work and then run:
+```
+dev release close 0.2.0
+```
+
+This will merge the release branch on the `master` branch.
+
+### Hotfix
+
+If you need to quickly fix a bug that accidentally made it to production, run:
+```bash
+dev hotfix open 0.2.1
+```
+
+You will be placed on a new branch called `hotfix/0.2.1`. While on this branch, write only code that fixes the bug(s) found. Do not start new features or continue developing existing ones. When you have fixed the bug run:
+```bash
+dev hotfix close 0.2.1
+```
+
+This will merge the hotfix branch on the `master` branch and on the `develop` branch.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,29 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Dev'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/bin/dev

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'active_support/all'
+require 'dev'
+
+exec = Dev::Executable.new(*ARGV)

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/lib/dev.rb

@@ -0,0 +1,12 @@
+require 'rainbow'
+
+require 'dev/executable'
+require 'dev/rainbow'
+require 'dev/version'
+
+module Dev
+  
+  # Carica il file rainbow.rb per stampare a colori.
+  load "#{File.expand_path('..', __dir__)}/lib/dev/rainbow.rb"
+
+end

data/lib/dev/engine.rb

@@ -0,0 +1,4 @@
+module Dev
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/dev/executable.rb

@@ -0,0 +1,205 @@
+require 'open3'
+require 'dev/project'
+require 'dev/executables/commands/version'
+require 'dev/executables/commands/status'
+require 'dev/executables/commands/feature'
+require 'dev/executables/commands/hotfix'
+require 'dev/executables/commands/release'
+require 'dev/executables/commands/pull'
+require 'dev/executables/commands/push'
+require 'dev/executables/commands/test'
+
+module Dev
+
+  ##
+  # Classe per gestire l'esecuzione del comando +dev+.
+  class Executable
+
+    ##
+    # Definisce la classe per tutti gli errori interni
+    # all'esecuzione.
+    class ExecutionError < StandardError; end
+
+    include Dev::Executables::Commands::Version
+    include Dev::Executables::Commands::Status
+    include Dev::Executables::Commands::Feature
+    include Dev::Executables::Commands::Hotfix
+    include Dev::Executables::Commands::Release
+    include Dev::Executables::Commands::Pull
+    include Dev::Executables::Commands::Push
+    include Dev::Executables::Commands::Test
+
+    # @return [Dev::Executables::Project] il progetto di riferimento.
+    attr_accessor :project
+    # @return [StandardError] l'errore riscontrato, se presente.
+    attr_accessor :error
+    # @return [String] il backtrace dell'errore, se presente.
+    attr_accessor :backtrace
+
+    ##
+    # Inizializza l'eseguibile, in base al comando passato.
+    #
+    # @param [Array] argv gli argomenti del comando.
+    def initialize(*argv)
+      begin
+        if argv[0].present?
+          if self.respond_to?(argv[0])
+            # Carica i dati del progetto
+            load_project
+            # Lancia il comando passato
+            if self.method(argv[0]).arity.abs > 0
+              self.send(argv[0], *argv[1..-1])
+            else
+              self.send(argv[0])
+            end
+          else
+            raise ExecutionError.new "Command '#{argv[0]}' is not supported. Run "\
+              "'dev help' for a list of available commands."
+          end
+        else
+          raise ExecutionError.new "Missing required parameters. Run 'dev help' "\
+            "for a list of available commands."
+        end
+      rescue Dev::Executable::ExecutionError => e
+        @error = e.message
+        puts @error.red
+      rescue StandardError => e
+        @error = "#{e.class}: #{e.message}"
+        @backtrace = e.backtrace.join("\n")
+        puts @error.red
+        puts @backtrace.red
+      end
+    end
+
+    ##
+    # Carica i dati del progetto prendendoli dal file
+    # di configurazione del file 'dev.yml'.
+    #
+    # @return [nil]
+    def load_project
+      config_file = Dir.glob("#{Dir.pwd}/**/dev.yml").first
+      raise ExecutionError.new "No valid configuration files found. Searched for a file named 'dev.yml' "\
+        "in folder #{Dir.pwd} and all its subdirectories." if config_file.nil?
+      @project = Dev::Project.new(config_file)
+    end
+
+    ##
+    # Determina de l'env è valido.
+    #
+    # @return [Boolean] se l'env è fra quelli validi.
+    def valid_env?
+      unless @env.in? [ :production, :staging ]
+        raise ExecutionError.new "The environment '#{@env}' is not valid. "\
+          "Valid environments are 'production' or 'staging'."
+      else
+        true
+      end
+    end
+
+    ##
+    # Esegue un comando e cattura l'output ritornandolo come
+    # risultato di questo metodo. Si può passare l'opzione
+    # +flush+ per stampare subito l'output come se non fosse stato
+    # catturato.
+    #
+    # @param [String] command il comando da eseguire.
+    # @param [Hash] options le opzioni.
+    #
+    # @return [nil]
+    def exec(command, options = {})
+      out, err, status = Open3.capture3(command)
+      command_output = [ out.presence, err.presence ].compact.join("\n")
+      if options[:flush] == true
+        puts command_output
+      else
+        command_output
+      end
+    end
+
+    ##
+    # Stampa i comandi possibili.
+    #
+    # @return [nil]
+    def help
+      puts
+      print "Dev".green
+      print " - available commands:\n"
+      puts
+      
+      print "\tversion\t\t".limegreen 
+        print "Prints current version.\n"
+        puts
+
+      print "\tfeature\t\t".limegreen
+        print "Opens or closes a feature for the current app.\n"
+        print "\t\t\tWarning: the app is determined from the current working directory!\n"
+        print "\t\t\tExample: "
+        print "dev feature open my-new-feature".springgreen
+        print " (opens a new feature for the current app)"
+        print ".\n"
+        print "\t\t\tExample: "
+        print "dev feature close my-new-feature".springgreen
+        print " (closes a developed new feature for the current app)"
+        print ".\n"
+        puts
+
+      print "\thotfix\t\t".limegreen
+        print "Opens or closes a hotfix for the current app.\n"
+        print "\t\t\tWarning: the app is determined from the current working directory!\n"
+        print "\t\t\tExample: "
+        print "dev hotfix open 0.2.1".springgreen
+        print " (opens a new hotfix for the current app)"
+        print ".\n"
+        print "\t\t\tExample: "
+        print "dev hotfix close 0.2.1".springgreen
+        print " (closes a developed new hotfix for the current app)"
+        print ".\n"
+        puts
+
+      print "\trelease\t\t".limegreen
+        print "Opens or closes a release for the current app.\n"
+        print "\t\t\tWarning: the app is determined from the current working directory!\n"
+        print "\t\t\tExample: "
+        print "dev release open 0.2.0".springgreen
+        print " (opens a new release for the current app)"
+        print ".\n"
+        print "\t\t\tExample: "
+        print "dev release close 0.2.0".springgreen
+        print " (closes a developed new release for the current app)"
+        print ".\n"
+        puts
+
+      print "\tpull\t\t".limegreen
+        print "Pulls specified app's git repository, or pulls all apps if none are specified.\n"
+        print "\t\t\tWarning: the pulled branch is the one the app is currently on!\n"
+        print "\t\t\tExample: "
+        print "dev pull [myapp]".springgreen
+        print ".\n"
+        puts
+
+      print "\tpush\t\t".limegreen
+        print "Commits and pushes the specified app.\n"
+        print "\t\t\tWarning: the pushed branch is the one the app is currently on!\n"
+        print "\t\t\tExample: "
+        print "dev push myapp \"commit message\"".springgreen
+        print ".\n"
+        puts
+
+      print "\ttest\t\t".limegreen
+        print "Runs the app's test suite. Tests must be written with rspec.\n"
+        print "\t\t\tIt is possibile to specify which app's test suite to run.\n"
+        print "\t\t\tIf nothing is specified, all main app's test suites are run.\n"
+        print "\t\t\tExample: "
+        print "dev test mymainapp myengine".springgreen
+        print " (runs tests for 'mymainapp' and 'myengine')"
+        print ".\n"
+        print "\t\t\tExample: "
+        print "dev test".springgreen
+        print " (runs tests for all main apps and engines within this project)"
+        print ".\n"
+        puts
+    end
+
+  end
+
+end

data/lib/dev/executables/commands/feature.rb

@@ -0,0 +1,111 @@
+module Dev
+  module Executables
+    module Commands
+      module Feature
+
+        ##
+        # Comandi per gestire l'apertura e la chiusura di una nuova feature.
+        #
+        # @param [String] command il comando da eseguire.
+        # @param [String] name il nome della feature.
+        #
+        # @return [nil]
+        def feature(command = nil, name = nil)
+          raise Dev::Executable::ExecutionError.new "Wrong command syntax: "\
+            "specify whether to open or close a feature. "\
+            "Example: dev feature open my-new-feature" unless command.in? [ 'open', 'close' ]
+          name = name.to_s.squish
+
+          if @project.valid_app?
+            case command
+            when 'open' then feature_open(name)
+            when 'close' then feature_close(name)
+            end
+          end
+        end
+
+        ##
+        # Apre una nuova feature.
+        #
+        # @param [String] name il nome della feature.
+        #
+        # @return [nil]
+        def feature_open(name)
+          print "Preparing to open a new feature for app "
+          print @project.current_app.teal
+          print " named "
+          puts name.teal
+          puts
+
+          branches = `git branch -a`
+          unless branches.include? ("develop\n")
+            print "\tCreating develop branch.."
+            exec "git checkout -b develop"
+            exec "git add ."
+            exec "git commit -m \"Dev: automatically created 'develop' branch\""
+            exec "git push -u origin develop"
+            print "√\n".green
+            puts
+          end
+
+          print "\tOpening.. "
+          git_output = exec "git checkout -b feature/#{name} develop"
+          if git_output.include?('fatal') or git_output.include?('rejected') or git_output.include?('error')
+            print "X\n".red
+            puts "\t\tSomething went wrong, take a look at the output from git:".indianred
+            puts "\t\t#{git_output.split("\n").map(&:squish).join("\n\t\t")}".indianred
+            puts
+          else
+            print "√\n".green
+            puts "\t\tDone. Output from git:".cadetblue
+            puts "\t\t#{git_output.split("\n").map(&:squish).join("\n\t\t")}".cadetblue
+            puts
+          end
+        end
+
+        ##
+        # Chiude una feature esistente.
+        #
+        # @param [String] name il nome della feature.
+        #
+        # @return [nil]
+        def feature_close(name)
+          print "Preparing to close the feature for app "
+          print @project.current_app.teal
+          print " named "
+          puts name.teal
+          puts
+
+          status = `git status`
+          if status.include? "Changes not staged for commit:"
+            raise Dev::Executable::ExecutionError.new "Your current branch has unstaged changes. Please "\
+              "commit or stash them before closing the feature."
+          end
+
+          branches = `git branch -a`
+          unless branches.include? ("feature/#{name}\n")
+            raise Dev::Executable::ExecutionError.new "No feature named '#{name}' could be found "\
+              "for this app's repository."
+          end
+
+          print "\tClosing.. "
+          exec "git checkout develop"
+          exec "git merge --no-ff feature/#{name}"
+          git_output = exec "git push origin develop"
+          if git_output.include?('fatal') or git_output.include?('rejected') or git_output.include?('error')
+            print "X\n".red
+            puts "\t\tSomething went wrong, take a look at the output from git:".indianred
+            puts "\t\t#{git_output.split("\n").map(&:squish).join("\n\t\t")}".indianred
+            puts
+          else
+            print "√\n".green
+            puts "\t\tDone. Output from git:".cadetblue
+            puts "\t\t#{git_output.split("\n").map(&:squish).join("\n\t\t")}".cadetblue
+            puts
+          end
+        end
+
+      end
+    end
+  end
+end