rgentpl 1.2.6 → 2.0.0

data/lib/rgentpl/command/generate.rb

@@ -11,53 +11,41 @@ module Rgentpl
       include Thor::Actions
 
       # Application path description
-      APP_PATH_DESC = 'Application path with current path as a default value'
-      # CTags description
-      CTAGS_DESC    = 'Full CTags path command (default: /usr/local/bin/ctags)'
+      APP_PATH_DESC = "Application path with current path as a default value"
 
       # @return [String] the final install application path
       attr_accessor :app_path
-      # @return [String] the ctags full binary path
-      attr_accessor :ctags
 
       # App name argument
       argument :app_name, type: :string, required: true,
-                          desc: 'Application name'
+        desc: "Application name"
       # @return [String] the application path root
       def self.source_root
         TEMPLATE_ROOT
       end
 
       class_option :app_path, type: :string,
-                              required: true,
-                              desc: APP_PATH_DESC,
-                              default: File.expand_path('.'),
-                              aliases: '-p'
-      class_option :ctags, type: :string,
-                           required: false,
-                           desc: CTAGS_DESC,
-                           default: '/usr/local/bin/ctags',
-                           aliases: '-t'
+        required: true,
+        desc: APP_PATH_DESC,
+        default: File.expand_path("."),
+        aliases: "-p"
       # @return [void]
       def create_app
-        @app_path = options['app_path']
-        @ctags    = options['ctags']
-        directory('src', "#{@app_path.chomp('/')}/#{app_name}")
+        @app_path = options["app_path"]
+        directory("src", "#{@app_path.chomp("/")}/#{app_name}")
       end
 
       # @return [void]
       def add_perms
-        chmod("#{@app_path.chomp('/')}/#{app_name}/bin/#{app_name}", 0755)
+        chmod("#{@app_path.chomp("/")}/#{app_name}/bin/#{app_name}", 0o755)
       end
 
       # @return [void]
       def git
         inside("#{app_path}/#{app_name}") do
-          run('git init')
-          run('git add .')
+          run("git init")
+          run("git add .")
           run('git commit -am "First sending."')
-          run('git checkout -b develop')
-          run('git checkout -b feature-domain-logic')
         end
       end
     end

data/lib/rgentpl/core/configuration.rb

@@ -24,7 +24,7 @@ module Rgentpl
     # @param exc [NoMethodError] the exception
     # @return [void]
     def add_new_attribute_from_exception(exc)
-      add_new_attribute(exc, exc.name.to_s.gsub(/=$/, ''))
+      add_new_attribute(exc, exc.name.to_s.gsub(/=$/, ""))
     end
 
     # Implementation for adding new attribute in configuration block
@@ -35,7 +35,7 @@ module Rgentpl
     def add_new_attribute(exc, method)
       @config.extend Virtus.model
       @config.attribute method.to_sym, String, default: exc.args.first,
-                                               lazy: true
+        lazy: true
       @config.send(exc.name, exc.args.first)
     end
     private :add_new_attribute
@@ -45,9 +45,9 @@ module Rgentpl
   class Configuration
     include Virtus.model
 
-    attribute :active,   Boolean,                default: true
+    attribute :active, Boolean, default: true
     attribute :log_file, String
-    attribute :options,  Hash[Symbol => String], default: {}
+    attribute(:options, {Symbol => String}, default: {})
 
     # Set custom default values
     #
@@ -56,7 +56,7 @@ module Rgentpl
     def initialize(*args)
       super
       # Bug - Update some default values
-      @log_file = Rgentpl.env + '.log'
+      @log_file = Rgentpl.env + ".log"
     end
 
     # Configuration

data/lib/rgentpl/core_ext/string.rb

@@ -7,14 +7,14 @@ module Rgentpl
       #
       # @return [String] the camelized string
       def camelize
-        split(/\s|-|_/).each(&:capitalize!).join('')
+        split(/\s|-|_/).each(&:capitalize!).join("")
       end
 
       # Camelize!
       #
       # @return [String] the camelized string
       def camelize!
-        replace(split(/\s|-|_/).each(&:capitalize!).join(''))
+        replace(split(/\s|-|_/).each(&:capitalize!).join(""))
       end
     end
   end

data/lib/rgentpl/version.rb

@@ -4,5 +4,5 @@
 #
 module Rgentpl
   # Version
-  VERSION = '1.2.6'
+  VERSION = "2.0.0"
 end

data/lib/rgentpl.rb

@@ -1,8 +1,8 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'virtus'
-require 'thor'
-require 'logger'
+require "rubygems"
+require "bundler/setup"
+require "virtus"
+require "thor"
+require "logger"
 
 # Rgentpl
 module Rgentpl
@@ -18,22 +18,20 @@ module Rgentpl
     require file
   end
 
-  require_relative 'rgentpl/version'
-  require_relative 'rgentpl/command/generate'
-  require_relative 'rgentpl/command/base'
-  require_relative 'rgentpl/boot/initializer'
-  require_relative 'rgentpl/boot/application'
-  require_relative 'rgentpl/core/configuration'
+  require_relative "rgentpl/version"
+  require_relative "rgentpl/command/generate"
+  require_relative "rgentpl/command/base"
+  require_relative "rgentpl/boot/initializer"
+  require_relative "rgentpl/boot/application"
+  require_relative "rgentpl/core/configuration"
 
   class << self
     # Environment
     #
     # @return [String] the current environment
     def env
-      unless defined?(TEMPLATE_ENV)
-        load File.expand_path('../../config/environment.rb',  __FILE__)
-      end
-      TEMPLATE_ENV
+      load File.expand_path("../config/environment.rb", __dir__) unless ENV.include? "TEMPLATE_ENV"
+      ENV["TEMPLATE_ENV"]
     end
 
     # Logger

data/lib/tasks/rspec.rake

@@ -0,0 +1,9 @@
+if ["test", "development"].include?(ENV["TEMPLATE_ENV"])
+  require "rspec"
+  require "rspec/core/rake_task"
+
+  desc "Run the specs under spec/"
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ["--options", ".rspec"]
+  end
+end

data/lib/tasks/rubycritic.rake

@@ -0,0 +1,12 @@
+require "colorize"
+
+namespace :rubycritic do
+  desc "RubyCritic code metrics"
+  task :check do
+    puts "- Run rubycritics checking process.".green
+    sh("rubycritic lib")
+    puts "- Process has finished.".green
+  end
+
+  task default: [:check]
+end

data/lib/tasks/standard.rake

@@ -0,0 +1,5 @@
+require "standard/rake"
+
+desc "Run Standard on the root directory"
+
+task default: "standard:fix"

data/lib/tasks/yard.rake

@@ -0,0 +1,17 @@
+begin
+  require "rspec"
+  require "rspec/core/rake_task"
+  require "yard"
+
+  desc "Generate docs under doc/api folder (YARD)"
+  YARD::Rake::YardocTask.new do |t|
+    t.files += ["lib/**/*.rb"]
+    t.options += ["--protected"]
+    t.options += ["--private"]
+    t.options += ["--output-dir", "doc/api"]
+    t.stats_options = ["--list-undoc"]
+  end
+  task doc: :yard
+rescue LoadError
+  warn "yard not available, yard task not provided."
+end

data/rgentpl.gemspec

@@ -1,74 +1,50 @@
-require File.expand_path('../lib/rgentpl/version', __FILE__)
+require File.expand_path("lib/rgentpl/version", __dir__)
 
 Gem::Specification.new do |gem|
-  gem.name          = "rgentpl"
-  gem.version       = Rgentpl::VERSION
-  gem.platform      = Gem::Platform::RUBY
-  gem.date          = '2015-05-17'
-  gem.summary       = %q{Ruby Skeleton Generator}
-  gem.description   = %q{Ruby Skeleton Generator based in templates}
-  gem.license       = "MIT"
-  gem.authors       = ["Julio Antúnez Tarín"]
-  gem.email         = "julio.antunez.tarin@gmail.com"
-  gem.homepage      = "https://github.com/jatap/rgentpl#readme"
-  gem.executables   = ["rgentpl"]
+  gem.name = "rgentpl"
+  gem.version = Rgentpl::VERSION
+  gem.platform = Gem::Platform::RUBY
+  gem.summary = "Ruby Skeleton Generator"
+  gem.description = "Ruby Skeleton Generator based in templates"
+  gem.license = "MIT"
+  gem.authors = ["Julio Antúnez Tarín"]
+  gem.email = "julio.antunez.tarin@gmail.com"
+  gem.homepage = "https://github.com/jatap/rgentpl#readme"
 
-  gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.require_paths = ['lib']
+  gem.files = `git ls-files`.split($/)
+  gem.executables = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.require_paths = ["lib"]
 
-  gem.add_runtime_dependency 'rake'
-  gem.add_runtime_dependency 'virtus'
-  gem.add_runtime_dependency 'thor'
+  gem.add_runtime_dependency "rake"
+  gem.add_runtime_dependency "thor"
+  gem.add_runtime_dependency "virtus"
+  gem.add_runtime_dependency "logger"
 
-  gem.add_development_dependency 'bundler', '>= 1.9'
-  gem.add_development_dependency 'ruby_gntp'
-  gem.add_development_dependency 'growl'
-  gem.add_development_dependency 'listen'
-  gem.add_development_dependency 'guard'
-  gem.add_development_dependency 'guard-bundler'
-  gem.add_development_dependency 'guard-rspec'
-  gem.add_development_dependency 'guard-rubocop'
-  gem.add_development_dependency 'guard-yard'
-  gem.add_development_dependency 'guard-cane'
-  gem.add_development_dependency 'guard-rubycritic'
-  gem.add_development_dependency 'rb-inotify', '>= 0.9.0'
-  gem.add_development_dependency 'rb-fsevent', '>= 0.9.3'
-  gem.add_development_dependency 'rb-fchange', '>= 0.0.6'
-  gem.add_development_dependency 'rubocop'
-  gem.add_development_dependency 'cane'
-  gem.add_development_dependency 'rcodetools'
-  gem.add_development_dependency 'fastri'
-  gem.add_development_dependency 'flay'
-  gem.add_development_dependency 'flog'
-  gem.add_development_dependency 'rubycritic'
-  gem.add_development_dependency 'excellent'
-  gem.add_development_dependency 'yard'
-  gem.add_development_dependency 'sdoc'
-  gem.add_development_dependency 'sdoc-templates-42floors'
-  gem.add_development_dependency 'redcarpet'
-  gem.add_development_dependency 'rspec', '>= 3.2'
-  gem.add_development_dependency 'simplecov'
-  gem.add_development_dependency 'simplecov-gem-adapter'
-  gem.add_development_dependency 'selenium-webdriver'
-  gem.add_development_dependency 'launchy'
-  gem.add_development_dependency 'capybara'
-  gem.add_development_dependency 'webrat'
-  gem.add_development_dependency 'rspec-nc', '>= 0.2.0'
-  gem.add_development_dependency 'rspec-abhakungszeichen-formatter'
-  gem.add_development_dependency 'nyan-cat-formatter'
-  gem.add_development_dependency 'fuubar', '>= 2.0.0'
-  gem.add_development_dependency 'ffaker'
-  gem.add_development_dependency 'byebug'
-  gem.add_development_dependency 'pry'
-  gem.add_development_dependency 'pry-doc'
-  gem.add_development_dependency 'pry-byebug'
-  gem.add_development_dependency 'awesome_print'
-  gem.add_development_dependency 'colorize'
-  gem.add_development_dependency 'bcrypt-ruby'
-  gem.add_development_dependency 'capistrano', '>= 3.4.0'
-  gem.add_development_dependency 'capistrano-rvm'
-  gem.add_development_dependency 'capistrano-bundler', '>= 1.1.2'
+  gem.add_development_dependency "awesome_print"
+  gem.add_development_dependency "bundler"
+  gem.add_development_dependency "byebug"
+  gem.add_development_dependency "colorize"
+  gem.add_development_dependency "debug", ">= 1.0.0"
+  gem.add_development_dependency "fuubar"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-bundler"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "guard-rubycritic"
+  gem.add_development_dependency "guard-standardrb"
+  gem.add_development_dependency "guard-yard"
+  gem.add_development_dependency "neovim"
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "pry-byebug"
+  gem.add_development_dependency "redcarpet"
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rspec-nc"
+  gem.add_development_dependency "rubocop-rake"
+  gem.add_development_dependency "rubocop-rspec"
+  gem.add_development_dependency "rubycritic"
+  gem.add_development_dependency "sdoc"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "solargraph"
+  gem.add_development_dependency "standard", "1.5.0"
+  gem.add_development_dependency "webrick"
+  gem.add_development_dependency "yard"
 end
-

data/spec/lib/rgentpl/boot/application_spec.rb

@@ -1,11 +1,9 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl::Application do
-  describe '#exec' do
-    it 'executes application' do
-      # Fix rake_taks bug
-      ARGV = []
-
+  describe "#exec" do
+    it "executes application" do
+      ARGV = [] # standard:disable Lint/ConstantDefinitionInBlock
       expect { Rgentpl::Application.exec }.to output(/commands:/).to_stdout
     end
   end

data/spec/lib/rgentpl/boot/initializer_spec.rb

@@ -1,18 +1,18 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl::Initializer do
-  describe '#build' do
-    it 'loads enviroment' do
-      expect(Rgentpl.env).to eq TEMPLATE_ENV
+  describe "#build" do
+    it "loads enviroment" do
+      expect(Rgentpl.env).to eq ENV["TEMPLATE_ENV"]
     end
 
-    context 'given initializers' do
+    context "given initializers" do
       let(:initializer) do
         File.expand_path("#{File.dirname(__FILE__)}/../../../../config/initializers/sample.rb")
       end
 
       before :each do
-        file = File.new(initializer, 'w')
+        file = File.new(initializer, "w")
         file.write "Rgentpl.configure { |c| c.new_key = 'New value' }"
         file.close
 
@@ -23,8 +23,8 @@ describe Rgentpl::Initializer do
         File.delete initializer
       end
 
-      it 'loads file' do
-        expect(Rgentpl.config.new_key).to eq 'New value'
+      it "loads file" do
+        expect(Rgentpl.config.new_key).to eq "New value"
       end
     end
   end

data/spec/lib/rgentpl/command/base_spec.rb

@@ -1,26 +1,26 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl::Command::Base do
-  context 'given a list of options' do
+  context "given a list of options" do
     let(:command) { Rgentpl::Command::Base.new }
 
-    it 'responds successfully to help, version and generate' do
+    it "responds successfully to help, version and generate" do
       [:help, :version, :generate].each do |element|
         expect(command).to respond_to element
       end
     end
   end
 
-  describe 'given a help option' do
-    it 'shows help info' do
+  describe "given a help option" do
+    it "shows help info" do
       expect { Rgentpl::Command::Base.help(Thor::Base.shell.new) }.to \
         output(/help/).to_stdout
     end
   end
 
-  describe 'given a version option' do
-    it 'shows version info' do
-      expect { Rgentpl::Command::Base.start %w( version ) }.to \
+  describe "given a version option" do
+    it "shows version info" do
+      expect { Rgentpl::Command::Base.start %w[version] }.to \
         output(/version/).to_stdout
     end
   end

data/spec/lib/rgentpl/command/generate_spec.rb

@@ -1,15 +1,15 @@
-require 'spec_helper'
-require 'fileutils'
+require "spec_helper"
+require "fileutils"
 
 describe Rgentpl::Command::Generate do
-  let(:app) { 'test_app' }
+  let(:app) { "test_app" }
 
   before do
-    Rgentpl::Command::Base.start %W( generate #{app} )
+    Rgentpl::Command::Base.start %W[generate #{app}]
   end
 
   let(:path) do
-    Rgentpl::Command::Generate.class_options[:app_path].default.chomp('/')
+    Rgentpl::Command::Generate.class_options[:app_path].default.chomp("/")
   end
   let(:file) { "#{path}/#{app}" }
 
@@ -17,21 +17,21 @@ describe Rgentpl::Command::Generate do
     FileUtils.rm_rf(file) if File.exist?(file)
   end
 
-  describe '#source_root' do
-    it 'sets application source path root' do
+  describe "#source_root" do
+    it "sets application source path root" do
       expect(Rgentpl::Command::Generate.source_root)
-        .to eq File.absolute_path(File.join(File.dirname(__FILE__), '../../../../'))
+        .to eq File.absolute_path(File.join(File.dirname(__FILE__), "../../../../"))
     end
   end
 
-  describe '.create_app' do
-    it 'adds a new directory with defined structure' do
+  describe ".create_app" do
+    it "adds a new directory with defined structure" do
       expect(File.exist?(file)).to be
     end
   end
 
-  describe '.add_perms' do
-    it 'add executions perms to binary file' do
+  describe ".add_perms" do
+    it "add executions perms to binary file" do
       expect(File.stat(File.join(file, "/bin/#{app}")).mode).to eq 33_261
     end
   end

data/spec/lib/rgentpl/core/configuration_spec.rb

@@ -1,47 +1,46 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl::Configuration do
   before :each do
     @configuration = Rgentpl::Configuration.new
   end
 
-  describe 'given expected attributes' do
+  describe "given expected attributes" do
     [:active,
-     :log_file,
-     :options].each do |expected_attribute|
-      it 'responds to each of them' do
+      :log_file,
+      :options].each do |expected_attribute|
+      it "responds to each of them" do
         expect(@configuration).to respond_to expected_attribute
       end
     end
   end
 
-  describe '#config' do
-    it 'is an Rgentpl::Configuration object' do
+  describe "#config" do
+    it "is an Rgentpl::Configuration object" do
       expect(Rgentpl.config).to be_kind_of Rgentpl::Configuration
     end
   end
 
-  context '#configure' do
-    before :each do
-      Rgentpl.configure do |config|
-        config.new_amazing_key = 'some value'
-        config.active          = false
-      end
-    end
-
-    describe 'can be configured with a block' do
-      it 'adding a new attribute' do
-        expect(Rgentpl.config.new_amazing_key).to eq 'some value'
+  context "#configure" do
+    describe "can be configured with a block" do
+      it "adding a new attribute" do
+        Rgentpl.configure do |config|
+          config.new_amazing_key = "some value"
+        end
+        expect(Rgentpl.config.new_amazing_key).to eq "some value"
       end
 
-      it 'updating an existing one' do
-        expect(Rgentpl.config.active).to be_falsey
+      it "updating an existing one" do
+        Rgentpl.configure do |config|
+          config.active = false
+        end
+        expect(Rgentpl.config.active).to eq false
       end
     end
   end
 
-  describe '.config' do
-    it 'an alias of Rgentpl.config' do
+  describe ".config" do
+    it "an alias of Rgentpl.config" do
       Rgentpl.config.active = false
       expect(Rgentpl.config.to_hash).to eq @configuration.config.to_hash
     end

data/spec/lib/rgentpl/core_ext/string_spec.rb

@@ -1,17 +1,17 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl::CoreExt do
-  let(:str) { String.new('My custom string') }
-  let(:result) { 'MyCustomString' }
+  let(:str) { +"My custom string" }
+  let(:result) { "MyCustomString" }
 
-  describe '.camelize' do
-    it 'format according to camelize rules' do
+  describe ".camelize" do
+    it "format according to camelize rules" do
       expect(str.camelize).to eq result
     end
   end
 
-  describe '.camelize!' do
-    it 'persists result into variable' do
+  describe ".camelize!" do
+    it "persists result into variable" do
       expect { str.camelize! }.to change { str }
     end
   end

data/spec/lib/rgentpl_spec.rb

@@ -1,24 +1,24 @@
-require 'spec_helper'
+require "spec_helper"
 
 describe Rgentpl do
-  describe '.env' do
-    it 'shows current environment' do
-      expect(Rgentpl.env).to eq('test')
+  describe ".env" do
+    it "shows current environment" do
+      expect(Rgentpl.env).to eq("test")
     end
 
-    context 'when none default environment is supplied' do
+    context "when none default environment is supplied" do
       before :each do
-        Object.send(:remove_const, :TEMPLATE_ENV)
+        ENV.delete "TEMPLATE_ENV"
       end
 
-      it 'adds development environment' do
-        expect(Rgentpl.env).to eq('development')
+      it "adds development environment" do
+        expect(Rgentpl.env).to eq("development")
       end
     end
   end
 
-  describe '.logger' do
-    it 'is a Logger object' do
+  describe ".logger" do
+    it "is a Logger object" do
       expect(Rgentpl.logger).to be_kind_of Logger
     end
   end