easy_app_helper 2.0.3 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53c79c3ab7f1d5d579b339daf801ddbf4075d52a
-  data.tar.gz: 1751310aea289a04187b81ea8234d3fce516d63b
+  metadata.gz: 0352ee0a8fcd905f3078f99d49ec0d0f1e760b4f
+  data.tar.gz: aa425b6c080f4b007e0b8eb21aa2d4871008a2ac
 SHA512:
-  metadata.gz: 880f828c67d419ac672e9d04733b821f705dec3854e73625e6963ee662beebb6110317a02c821585f1748a23653d0195cf3efbae7df91ae8c51bdaab5ff121fb
-  data.tar.gz: a0099a111124742ff41ad1b9f594dd3eff987bdc35c1f6cf470d193ae3dc2dbd812a49ad9621d86560cdfb046f8d6a59df889f7f11a4ffdd2c94d4e1dcca56d7
+  metadata.gz: 0fd9cd9cbc19b33177d7d26f89670bff03ee4fa5317adec804e5c7144230ee7d64e6fa854d165dfedee49fd149218e8b806eeb292ca7e968adb94ee8931be35f
+  data.tar.gz: 1cad685afd543aecab65bb53b24befd86af6d3c632e21a6ea23a36c3fa2968a92e214a9221af9bdc7a36bc75aaf0033e4cc752376bfc8022ffbbbc306efdba3b

data/.gitignore

@@ -46,3 +46,6 @@ tmp
 .idea
 #RedCar
 .redcar
+# bin directory should be ignored as created by the rake task.
+bin
+test/foo/bin

data/README.md

@@ -174,11 +174,72 @@ nevertheless be the case.
 There is a (not perfect) compatibility mode that you can trigger by setting the `easy_app_helper_compatibility_mode`
 property to true in one of your config files.
 
-## Complete example of a script based on `easy_app_helper`
+## Generate scripts using rake task
+
+### Including easy_app_helper tasks in your own gems.
+
+For this you just need to include in your own gem `Rakefile`:
+
+```ruby
+spec = Gem::Specification.find_by_name 'easy_app_helper'
+load "#{spec.gem_dir}/Rakefile"
+```
+This will add two extra rake tasks to your gem. Normally if you created correctly your gem (`bundle gem my_gem`), you
+already have 3 tasks existing coming from the `require "bundler/gem_tasks"` that you probably have in your default
+Rakefile. Now will get something like this instead:
+
+```shell
+$ bundle exec rake -T
+rake build                                               # Build your_gem-0.0.1.gem into the pkg directory
+rake easy_app_helper:create_executable[executable_name]  # create automatically a new executable in "bin" from a template
+rake easy_app_helper:show_template                       # Displays the template used
+rake install                                             # Build and install your_gem-0.0.1.gem into system gems
+rake release                                             # Create tag v0.0.1 and build and push your_gem-0.0.1.gem to Rubygems
+```
+The two [easy_app_helper][EAH] tasks are quite self-explanatory.
+
+### Generating script templates for your project
+
+Basically you will do a:
+
+    $ bundle rake easy_app_helper:create_executable
+
+And it will reply something like:
+
+```
+File '/home/you/devel/ruby/gems/your_gem/bin/your_gem' created with execution rights.
+ -> Try: "bundle exec '/home/you/devel/ruby/gems/your_gem/bin/your_gem' --help"
+```
 
-Save the following file somewhere as `example.rb`.
+It means that by default, the rake task will create a executable with the name of the gem you are currently developing.
+__This task is safe and will never overwrite an existing file__. Instead, if the file already exists, you would get:
+
+```
+File '/home/you/devel/ruby/gems/your_gem/bin/your_gem' already exists !
+ -> Aborted.
+```
+
+You can, of course, specify your own file name to the rake task. Depending on your shell, and due to different
+variable expansion mechanisms, you have to do it differently:
+
+* __zsh__ should be something like: `bundle rake easy_app_helper:create_executable\[my_executable\]`
+* whereas in __bash__ more probably: `bundle rake easy_app_helper:create_executable[my_executable]`
+
+Check the documentation of your shell for further information.
+You should nevertheless have this kind of answer from the task:
+
+```
+File '/home/you/devel/ruby/gems/your_gem/bin/my_executable' created with execution rights.
+ -> Try: "bundle exec '/home/you/devel/ruby/gems/your_gem/bin/my_executable' --help"
+```
+
+You can notice the slight changes in terms of code in the two generated scripts ;-). Check the template with
+`bundle rake easy_app_helper:show_template` to understand how the template adapts.
+
+
+## Complete example of a script based on `easy_app_helper`
 
-You can use this as a template for your own scripts:
+This is not exactly what is generated by the rake task (which is more up-to-date), but gives an overall idea:
 
 ```ruby
 #!/usr/bin/env ruby
@@ -194,6 +255,7 @@ class MyApp
   DESCRIPTION = 'Best app ever'
 
   def initialize
+    config.config_file_base_name = 'basename_for_my_config_files' # Default is the name of this script (w/o extensions)
     config.describes_application app_name: NAME,
                                  app_version: VERSION,
                                  app_description: DESCRIPTION

data/Rakefile

@@ -1 +1,6 @@
 require 'bundler/gem_tasks'
+
+load File.expand_path('../lib/tasks/easy_app_helper_tasks.rake', __FILE__)
+
+
+

data/easy_app_helper.gemspec

@@ -23,5 +23,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rspec', '~> 3.0'
 
-  spec.add_runtime_dependency 'stacked_config', '~> 0.1', '>= 0.1.3'
+  spec.add_dependency 'activesupport'
+  spec.add_runtime_dependency 'stacked_config', '~> 0.3'
 end

data/lib/easy_app_helper/version.rb

@@ -1,3 +1,3 @@
 module EasyAppHelper
-  VERSION = '2.0.3'
+  VERSION = '2.1.0'
 end

data/lib/tasks/easy_app_helper_tasks.rake

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require File.expand_path '../template_manager.rb', __FILE__
+
+namespace :easy_app_helper do
+
+  include EasyAppHelper::Tasks::TemplateManager
+
+  desc 'create automatically a new executable in "bin" from a template. Default name is Gem name'
+  task :create_executable, [:executable_name] do |tsk, args|
+    @task = tsk
+    script_content = build_executable args[:executable_name]
+    bin_dir = check_bin_dir
+    script_name = File.join bin_dir, executable_name
+    if File.exists? script_name
+      STDERR.puts "File '#{script_name}' already exists !\n -> Aborted."
+      next
+    end
+    File.write script_name, script_content
+    FileUtils.chmod 'u=wrx,go=rx', script_name
+    puts "File '#{script_name}' created with execution rights.\n -> Try: \"bundle exec '#{script_name}' --help\" to test it."
+  end
+
+  desc 'Displays the template used.'
+  task :show_template do
+    puts get_template
+  end
+
+end
+

data/lib/tasks/template.rb.erb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+# This file has been generated by easy_app_helper Gem on the <%= current_date %>
+# See 'https://rubygems.org/gems/easy_app_helper'
+
+require 'easy_app_helper'
+require '<%= gem_name %>'
+
+module <%= gem_module %>
+  class <%= script_class %>
+
+    # Inserted here, but you may probably have already defined this somewhere else...
+    NAME = '<%= executable_name.titleize %>'
+    DESCRIPTION = 'Description of <%= executable_name %>'
+
+    include EasyAppHelper
+
+    def initialize
+      <% unless executable_name == gem_name -%>config.config_file_base_name = '<%= executable_name %>'
+      <% end -%>config.describes_application app_name: NAME,
+                                   app_version: <%= gem_module %>::VERSION,
+                                   app_description: DESCRIPTION
+      add_script_options
+    end
+
+    def run
+      # logging startup configuration
+      logger.debug "Config layers ->\n#{config.detailed_layers_info}"
+      logger.debug "Merged config -> #{config[].to_yaml}"
+      # Displaying (and exiting) command line help
+      if config[:help]
+        puts config.command_line_help
+        exit 0
+      end
+      check_config
+      logger.info 'Application is starting...'
+      do_process
+    rescue => e
+      puts "Program aborted with message: '#{e.message}'."
+      if config[:debug]
+        logger.fatal "#{e.message}\nBacktrace:\n#{e.backtrace.join("\n\t")}"
+      else
+        puts '  Use --debug option for more detail (see --help).'
+      end
+    end
+
+    private
+
+    def add_script_options
+      ## Create here your extra command-line options
+      ## Here under are examples using potentially gem config layer to display default option value...
+      ## Check Slop documentation for further info.
+      # config.add_command_line_section do |slop|
+        # slop.on :p, :port, "Specify port to bind to. Default #{config.gem_layer[:port]}.", argument: true, as: Integer
+        # slop.on :b, :bind, "Specify address to bind to. Default #{config.gem_layer[:bind]}.", argument: true, as: String
+      # end
+    end
+
+    def do_process
+      # Your code here.
+    end
+
+    def check_config
+      # Check the config and raise an exception if incorrect.
+    end
+
+  end
+end
+
+<%= gem_module %>::<%= script_class %>.new.run

data/lib/tasks/template_manager.rb

@@ -0,0 +1,57 @@
+require 'erb'
+require 'active_support/core_ext/string/inflections'
+
+module EasyAppHelper
+  module Tasks
+
+    module TemplateManager
+
+      attr_reader :executable_name, :gem_module, :gem_name, :current_date, :script_class, :task
+
+      TEMPLATE = File.expand_path '../template.rb.erb', __FILE__
+
+      def get_template
+        File.read TEMPLATE
+      end
+
+      def check_bin_dir
+        spec = current_gem_spec
+        rel_bin_dir = spec.bindir.empty? ? 'bin' : spec.bindir
+        bin_dir = File.join task.application.original_dir, rel_bin_dir
+        FileUtils.mkdir bin_dir unless Dir.exists? bin_dir
+        bin_dir
+      end
+
+      def build_executable(executable_name=current_gem_name)
+        executable_name ||= current_gem_spec.name
+        @executable_name = executable_name
+        @gem_name = current_gem_spec.name
+        @gem_module = @gem_name.camelize
+        @current_date = Time.now.strftime('%c')
+        @script_class = executable_name == current_gem_spec.name ? '' : executable_name.camelize
+        @script_class << 'Script'
+        renderer = ERB.new(File.read(TEMPLATE), nil, '-')
+        renderer.result binding
+      end
+
+      def current_gem_spec
+        searcher = if Gem::Specification.respond_to? :find
+                     # ruby 2.0
+                     Gem::Specification
+                   elsif Gem.respond_to? :searcher
+                     # ruby 1.8/1.9
+                     Gem.searcher.init_gemspecs
+                   end
+        unless searcher.nil?
+          searcher.find do |spec|
+            original_file = task ? File.join(task.application.original_dir, task.application.rakefile) : __FILE__
+            File.fnmatch(File.join(spec.full_gem_path,'*'), original_file)
+          end
+        end
+      end
+
+
+    end
+
+  end
+end

data/test/foo/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in foo.gemspec
+gemspec
+
+gem 'easy_app_helper', path: File.expand_path('../../..', __FILE__)

data/test/foo/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 L.Briais
+
+MIT License
+
+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/test/foo/README.md

@@ -0,0 +1,29 @@
+# Foo
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'foo'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install foo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/foo/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/test/foo/Rakefile

@@ -0,0 +1,8 @@
+puts 'In the Test Gem'
+require 'bundler/gem_tasks'
+
+require 'easy_app_helper'
+
+spec = Gem::Specification.find_by_name 'easy_app_helper'
+load "#{spec.gem_dir}/Rakefile"
+

data/test/foo/foo.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foo/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'foo'
+  spec.version       = Foo::VERSION
+  spec.authors       = ['bar']
+  spec.email         = ['bar@nowhere.org']
+  spec.summary       = %q{Does Nothing.}
+  spec.description   = %q{Does nothing, no more.}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+
+  spec.add_runtime_dependency 'easy_app_helper'
+
+end

data/test/foo/lib/foo/version.rb

@@ -0,0 +1,3 @@
+module Foo
+  VERSION = '0.0.1'
+end

data/test/foo/lib/foo.rb

@@ -0,0 +1,5 @@
+require 'foo/version'
+
+module Foo
+  # Your code goes here...
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_app_helper
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 2.1.0
 platform: ruby
 authors:
 - L.Briais
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-29 00:00:00.000000000 Z
+date: 2015-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,25 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: stacked_config
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.1'
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: stacked_config
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.1'
-    - - '>='
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.1.3
+        version: '0.3'
 description: Easy Application Helpers framework
 email:
 - lbnetid+rb@gmail.com
@@ -109,10 +117,20 @@ files:
 - lib/easy_app_helper/logger/wrapper.rb
 - lib/easy_app_helper/managed_logger.rb
 - lib/easy_app_helper/version.rb
+- lib/tasks/easy_app_helper_tasks.rake
+- lib/tasks/template.rb.erb
+- lib/tasks/template_manager.rb
 - spec/config_spec.rb
 - spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
 - spec/spec_helper.rb
+- test/foo/Gemfile
+- test/foo/LICENSE.txt
+- test/foo/README.md
+- test/foo/Rakefile
+- test/foo/foo.gemspec
+- test/foo/lib/foo.rb
+- test/foo/lib/foo/version.rb
 homepage: https://github.com/lbriais/easy_app_helper
 licenses:
 - MIT
@@ -133,7 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
 summary: Provides cool helpers to your application, including configuration and logging
@@ -143,3 +161,10 @@ test_files:
 - spec/easy_app_helper_spec.rb
 - spec/logger_spec.rb
 - spec/spec_helper.rb
+- test/foo/Gemfile
+- test/foo/LICENSE.txt
+- test/foo/README.md
+- test/foo/Rakefile
+- test/foo/foo.gemspec
+- test/foo/lib/foo.rb
+- test/foo/lib/foo/version.rb