folder_template 0.1.1 → 1.0.0

data/templates/rubyclass/context.rb

@@ -0,0 +1,15 @@
+# rubygem/context.rb
+
+# Required variables:
+# - name : The name of the class to be created
+
+# Variables inherited from project context
+# - project_name
+# - project_namespace
+# - copyright_owner
+# - copyright_year
+
+
+let( :class_filename )      { name.underscore }
+let( :class_name )          { class_filename.capitalize.camelcase }
+let( :_ )                   { '' }

data/{test/data/test_append → templates/rubyclass}/template/lib/{{project_name}}/{{class_filename}}.rb

@@ -1,13 +1,15 @@
 # =============================================================================
-#  
-# MODULE      : lib/{{project_name}}/{{class_filename}}.rb
+#
+# MODULE      : {{filename}}
 # PROJECT     : {{project_namespace}}
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
 # =============================================================================
 
 module {{project_namespace}}
   class {{class_name}}
-  end
-end
+
+
+  end # class {{class_name}}
+end # module {{project_namespace}}

data/{test/data/test1/template/test_/_test_{{class_filename}}.rb → templates/rubyclass/template/test/test_{{class_filename}}.rb}

@@ -1,20 +1,23 @@
 # =============================================================================
-#  
-# MODULE      : test/{{project_name}}/test_{{class_filename}}.rb
+#
+# MODULE      : {{filename}}
 # PROJECT     : {{project_namespace}}
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
 # =============================================================================
 
+
+require '_test_env.rb'
+
 module {{project_namespace}}
-  
   describe {{class_name}} do
+
     subject { {{class_name}}.new }
-    
+
     it "passes this one" do
       subject.must_be_instance_of {{class_name}}
     end
-  end
 
+  end
 end

data/templates/rubygem/context.rb

@@ -0,0 +1,15 @@
+# rubygem/context.rb
+
+# Required variables:
+#  - target_path : path in which the template will be expanded
+
+
+let( :folder_name )         { File.basename(target_path) }
+
+let( :project_name )        { folder_name }
+let( :project_namespace )   { folder_name.capitalize.camelcase }
+let( :username )            { `id -F`.strip }
+let( :copyright_owner )     { username }
+let( :copyright_year )      { Time.now.year }
+
+let( :_ )                   { '' } 

data/templates/rubygem/template/Gemfile

@@ -0,0 +1,13 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+
+source 'https://rubygems.org'
+gemspec

data/templates/rubygem/template/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+
+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/templates/rubygem/template/README.md

@@ -0,0 +1,49 @@
+# FolderTemplate
+
+[![Gem Version](https://badge.fury.io/rb/{{project_name}}.svg)](https://badge.fury.io/rb/{{project_name}})
+[![Build Status](https://travis-ci.org/{{travis_account}}/{{project_name}}.svg?branch=master)](https://travis-ci.org/{{travis_account}}/{{project_name}})
+[![Code Climate](https://codeclimate.com/github/{{github_account}}/{{project_name}}/badges/gpa.svg)](https://codeclimate.com/github/{{github_account}}/{{project_name}})
+[![Issue Count](https://codeclimate.com/github/{{github_account}}/{{project_name}}/badges/issue_count.svg)](https://codeclimate.com/github/{{github_account}}/{{project_name}})
+
+
+
+
+# Project
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/{{project_name}}`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem '{{project_name}}'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install {{project_name}}
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/{{project_name}}/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 a new Pull Request

data/{test/data/test1/template/lib/{{project_name}}/{{class_filename}}.rb → templates/rubygem/template/lib/{{project_name}}/version.rb}

@@ -1,13 +1,12 @@
 # =============================================================================
-#  
-# MODULE      : lib/{{project_name}}/{{class_filename}}.rb
+#
+# MODULE      : {{filename}}
 # PROJECT     : {{project_namespace}}
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
 # =============================================================================
 
 module {{project_namespace}}
-  class {{class_name}}
-  end
+  VERSION = '0.0.1'
 end

data/templates/rubygem/template/lib/{{project_name}}.rb

@@ -0,0 +1,12 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+
+require_relative '{{project_name}}/version.rb'

data/templates/rubygem/template/rakefile.rb

@@ -0,0 +1,110 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task default: [:test, :build]
+
+Rake::TestTask.new do |t|
+  t.libs << '.' << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+  t.verbose = false
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definitions to help formating 'rake watch' results
+# ----------------------------------------------------------------------------
+
+TERM_WIDTH = `tput cols`.to_i || 80
+
+def tty_red(str);           "\e[31m#{str}\e[0m" end
+def tty_green(str);         "\e[32m#{str}\e[0m" end
+def tty_blink(str);         "\e[5m#{str}\e[25m" end
+def tty_reverse_color(str); "\e[7m#{str}\e[27m" end
+
+def print_separator( success = true )
+  if success
+    puts tty_green( "-" * TERM_WIDTH )
+  else
+    puts tty_reverse_color(tty_red( "-" * TERM_WIDTH ))
+  end
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definition of watch task, that monitors the project folder for any relevant
+# file change and runs the unit test of the project.
+# ----------------------------------------------------------------------------
+
+begin
+  require 'watch'
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :watch do
+    Watch.new( '**/*.rb' ) do
+      success = system "clear && rake test"
+      print_separator( success )
+    end
+  end
+
+rescue LoadError
+
+  desc 'Run unit tests everytime a source or test file is changed'
+  task :watch do
+    puts
+    puts "'rake watch' requires the watch gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install watch"
+    puts " or "
+    puts "    sudo gem install watch"
+    puts
+    fail
+  end
+end
+
+
+
+# ----------------------------------------------------------------------------
+# Definition of add_class[class_name] task, that uses folder_template to add
+# a new class to a ruvy project
+# ----------------------------------------------------------------------------
+
+PROJECT_CONTEXT = {
+  project_name:       "{{project_name}}",
+  project_namespace:  "{{project_namespace}}",
+  copyright_owner:    "{{copyright_owner}}",
+  copyright_year:     "{{copyright_year}}",
+}
+
+begin
+  require 'folder_template'
+
+  task :add_class, :class_name do |t, args|
+    context = PROJECT_CONTEXT.merge( name:args[:class_name])
+    FolderTemplate::SetupFolderCmd.run( '.', 'rubyclass', context )
+  end
+rescue LoadError
+  task :add_class, :class_name do |t, args|
+    puts
+    puts "'rake add_class[class_name]' task requires the folder_template gem to be available"
+    puts
+    puts "To install:"
+    puts "    gem install folder_template"
+    puts " or "
+    puts "    sudo gem install folder_template"
+    puts
+    fail
+  end
+end

data/templates/rubygem/template/test/_test_env.rb

@@ -0,0 +1,27 @@
+# =============================================================================
+#
+# MODULE      : {{filename}}
+# PROJECT     : {{project_namespace}}
+# DESCRIPTION :
+#
+# Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
+# =============================================================================
+
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'fileutils'
+require 'pp'
+require 'rr'
+
+require 'lib/{{project_name}}.rb'
+
+# Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+
+module Minitest::Assertions
+  def assert_custom( expected, actual )
+    assert false, "assert_custom() always fails\n" +
+                  "  Expected: #{expected.inspect}\n" +
+                  "  Actak:    #{actual.inspect}\n"
+  end
+end

data/{test/data/test_append/template/test_/_test_{{class_filename}}.rb → templates/rubygem/template/test/test_version.rb}

@@ -1,20 +1,23 @@
 # =============================================================================
-#  
-# MODULE      : test/{{project_name}}/test_{{class_filename}}.rb
+#
+# MODULE      : {{filename}}
 # PROJECT     : {{project_namespace}}
-# DESCRIPTION : 
+# DESCRIPTION :
 #
 # Copyright (c) {{copyright_year}}, {{copyright_owner}}.  All rights reserved.
 # =============================================================================
 
+
+require '_test_env.rb'
+
 module {{project_namespace}}
-  
-  describe {{class_name}} do
-    subject { {{class_name}}.new }
-    
-    it "passes this one" do
-      subject.must_be_instance_of {{class_name}}
+  describe VERSION do
+
+    subject { VERSION }
+
+    it "is definied as a string" do
+      subject.must_be_instance_of String
     end
-  end
 
+  end
 end

data/templates/rubygem/template/{{_}}.codeclimate.yml

@@ -0,0 +1,25 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- test/

data/templates/rubygem/template/{{_}}.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/tmp/