rubynew 1.0.0 → 1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 69431f4a2d406cc85339e4406e7df9869c542424
-  data.tar.gz: e84baa2941b14073dde56ce538fdc03a8079146f
+  metadata.gz: a6063f5baba77f1be01af65181e27d24e40feb84
+  data.tar.gz: 41664657d14639f6d299873b6b51d32c9064c0c1
 SHA512:
-  metadata.gz: 05d092b8df397bbd70559af098cada1ee857e44ed5333bd255e290c40bd93c293b2dd87dd0d8bd29136cddacb0411ad0cf3041b9fbf15ce03656adb419c9eb76
-  data.tar.gz: 2c8c8335966289162e6eb47ab27a00f6e7749f28d7ecb8e5c51a9ee3ba858b1e0aca47c1c30695a9d6020ca72320cc4a44fcbcc9278450bc314bddbb7659c9fa
+  metadata.gz: 2941e817ff57c3852d80bdaf89654994c4772aa21e54fbb75aa966c1ddd58d90f93fa12de414285c9c66b54f64eff03fa81b1d3d874641566f5fc481d962cbe8
+  data.tar.gz: c099b1c63f3c16c6aaa683993488f77375fdcf5db4a80723d99b9ae868983ed7e41d5c5d26989f6b13b6638895518c97578d28ccc4c63e32e00898f6881ebd85

data/README.md

@@ -21,11 +21,14 @@ Bundler works when creating a gem.
 $ rubynew tip_calculator
 ```
 
-It creates the following structure:
+It creates the following structure and files:
 
 ```
 tip_calculator/
+├── Gemfile
 ├── Rakefile
+├── README.md
+├── LICENSE
 ├── bin
 │   └── tip_calculator
 ├── lib
@@ -33,6 +36,7 @@ tip_calculator/
 │   │   └── version.rb
 │   └── tip_calculator.rb
 └── test
+    └── test_helper.rb
     └── tip_calculator_test.rb
 ```
 
@@ -50,18 +54,27 @@ To contribute:
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
 
-## License
-
-MIT. See LICENSE.txt.
 
 ## History
 
-2016-03-05
+2016-08-21 v1.1
+
+* Added `README.md`, `LICENSE`, and `Gemfile`
+* Added `test/test_helper.rb` for tests to use as their setup instead of directly loading `minitest/autorun`
+* Added `minitest/reporters` gem and added configuration to `test_helper` so test reports are colorized.
+* `bin` program now displays name and version
+* More detailed help message for `rubynew` when no options are passed
+* `rubynew` no longer crashes when you use a folder that already exists. This behavior is no longer allowed.
+
+
+2016-03-05 v1.0.0
 
 * Added `bin` folder and default bin file.
-* 1.0.0 version
 
 2015-08-23
 
 * Initial version
 
+## License
+
+MIT. See LICENSE.txt.

data/bin/rubynew

@@ -4,12 +4,35 @@ require "rubynew"
 
 folder = ARGV[0]
 
+def banner
+  puts "rubynew v#{Rubynew::VERSION} (C) 2015-2016 Brian P Hogan"
+end
+
+banner
+
 if folder.nil?
-  puts "Specify a folder name and I'll create it."
+  puts %Q{
+Specify a folder and I'll create a Ruby project in that folder with
+
+* A lib/ folder with version.rb and a main Ruby file
+* A test/ folder with a test_helpr file and example test
+* A Rakefile
+* A Gemfile
+* A bin/ folder with everything wired up.
+
+Example:
+
+rubynew awesome_project
+  }
 else
-  project = Rubynew::Project.new(folder)
-  project.create
-  puts "\nCreated folder #{folder}."
-  puts "To use it, type: \n\tcd #{folder}\n\nand run tests with\n\n\trake test"
-  puts "Run the program with \n\truby bin/#{folder}."
+  if File.exists?(folder)
+    puts "This folder already exists. Please specify a folder that doesn't exist."
+  else
+    project = Rubynew::Project.new(folder)
+    project.create
+    puts "\nCreated new Ruby project in #{folder}.\n\n"
+    puts "To use this project, type: \n\n\tcd #{folder}\n\nInstall dependencies with\n\n\tbundle install\n\nand run tests with\n\n\trake test\n\n"
+    puts "Run the program with \n\n\truby bin/#{folder}\n\n"
+
+  end
 end

data/lib/rubynew/project.rb

@@ -28,11 +28,10 @@ module Rubynew
         File.join(@name, "bin",  @underscored_name),
         File.join(@name, "lib",  "#{@underscored_name}.rb"),
         File.join(@name, "lib",  @underscored_name, "version.rb"),
-        File.join(@name, "test", "#{@underscored_name}_test.rb")
+        File.join(@name, "test", "#{@underscored_name}_test.rb"),
+        File.join(@name, "README.md")
       ].each { |file| render_template_to_file file, binding }
 
-
-
     end
 
     private

data/lib/rubynew/version.rb

@@ -1,3 +1,3 @@
 module Rubynew
-  VERSION = "1.0.0"
+  VERSION = "1.1"
 end

data/rubynew.gemspec

@@ -23,6 +23,10 @@ Gem::Specification.new do |spec|
                         "template/lib/app/version.rb",
                         "template/lib/app.rb",
                         "template/test/app_test.rb",
+                        "template/test/test_helper.rb",
+                        "template/Gemfile",
+                        "template/README.md",
+                        "template/LICENSE",
                         "test/rubynew_test.rb",
                         "Rakefile",
                         "Gemfile",

data/template/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+gem 'minitest', group: :test
+gem 'minitest-reporters', group: :test
+

data/template/LICENSE

@@ -0,0 +1,8 @@
+The MIT License (MIT)
+Copyright (c) <year> <copyright holders>
+
+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/template/README.md

@@ -0,0 +1,20 @@
+# <%= @underscored_name %>
+
+This software...
+
+## Installation
+
+
+## Usage
+
+## Contributing
+
+## Changelog
+
+### Version 0.0.1
+
+* Initial release
+
+## License
+
+See LICENSE

data/template/Rakefile

@@ -5,3 +5,5 @@ Rake::TestTask.new do |t|
   t.test_files = FileList["test/*_test.rb"]
   t.verbose = true
 end
+
+task :default => :test

data/template/bin/app

@@ -3,4 +3,8 @@
 $LOAD_PATH << File.expand_path(File.dirname(__FILE__) + '/../lib')
 require '<%= @underscored_name %>'
 
-puts "This is the <%= @underscored_name %> app."
+def banner
+  puts "<%= @underscored_name %> v#{<%= @constant_name %>::VERSION}."
+end
+
+banner

data/template/lib/app.rb

@@ -1,5 +1,14 @@
+# Load Bundler and load all your gems
+require "bundler/setup"
+
+# Explicitly load any gems you need.
+
 require "<%= @underscored_name %>/version"
 
 module <%= @constant_name %>
   # Your code goes here...
+  # Good place for your main application logic if this is a library.
+  #
+  # Create classes in the <%= @underscored_name %> folder and
+  # be sure to create unit tests for them too.
 end

data/template/lib/app/version.rb

@@ -1,3 +1,3 @@
 module <%= @constant_name %>
-  VERSION = "0.0.2"
+  VERSION = "0.0.1"
 end

data/template/test/app_test.rb

@@ -1,8 +1,11 @@
-require "minitest/autorun"
+require "test_helper"
+
 require "<%= @underscored_name %>"
 
 class <%= @constant_name %>Test < Minitest::Test
+
   def test_fails
     flunk "Gotta write a test!"
   end
+
 end

data/template/test/test_helper.rb

@@ -0,0 +1,6 @@
+# Your tests should require this file which sets up the test harness.
+require "minitest/autorun"
+require 'minitest/reporters'
+
+reporter_options = { color: true }
+Minitest::Reporters.use! [Minitest::Reporters::DefaultReporter.new(reporter_options)]

data/test/rubynew_test.rb

@@ -19,6 +19,9 @@ class RubynewTest < MiniTest::Test
     Rubynew::Project.new(@folder).create
 
     assert File.exist?(File.join(@folder, "Rakefile"))
+    assert File.exist?(File.join(@folder, "Gemfile"))
+    assert File.exist?(File.join(@folder, "README.md"))
+    assert File.exist?(File.join(@folder, "LICENSE"))
     assert File.exist?(File.join(@folder, "lib", "#{@folder}.rb"))
     assert File.exist?(File.join(@folder, "lib", @folder, "version.rb"))
     assert File.exist?(File.join(@folder, "test", "#{@folder}_test.rb"))
@@ -76,11 +79,22 @@ class RubynewTest < MiniTest::Test
   end
 
   def test_has_bin
-
     Rubynew::Project.new(@folder).create
 
     file = Pathname.new(File.join(@folder, "bin", @folder))
     assert file.read.include?("$LOAD_PATH")
     assert file.read.include?("require 'tmpproject'")
   end
+
+  def test_bin_displays_name_and_version
+    Rubynew::Project.new(@folder).create
+    file = Pathname.new(File.join(@folder, "bin", @folder))
+    assert file.read.include?('tmpproject v#{Tmpproject::VERSION}')
+  end
+
+  def readme_has_project_name_as_header
+    Rubynew::Project.new(@folder).create
+    file = Pathname.new(File.join(@folder, "README.md"))
+    assert file.read.include?("# tmpproject\n")
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubynew
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: '1.1'
 platform: ruby
 authors:
 - Brian Hogan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,11 +70,15 @@ files:
 - lib/rubynew/project.rb
 - lib/rubynew/version.rb
 - rubynew.gemspec
+- template/Gemfile
+- template/LICENSE
+- template/README.md
 - template/Rakefile
 - template/bin/app
 - template/lib/app.rb
 - template/lib/app/version.rb
 - template/test/app_test.rb
+- template/test/test_helper.rb
 - test/rubynew_test.rb
 homepage: http://github.com/napcs/rubynew
 licenses:
@@ -96,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Generate new Ruby projects with tests.