skellington 0.4.9 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5106f17cf64f2e38d1c05be8e991116246a0b9da
-  data.tar.gz: 7a9099578f36103b64a781ca82d4caff7795e8d9
+  metadata.gz: 3f792949505bdf108189229c2efc1417fb6d60bf
+  data.tar.gz: d2c5d61429ec03098c5f7f92ce326ec0cd3a819f
 SHA512:
-  metadata.gz: 6477c86bfef764b3015045dfcb77116bfa936f5545c642d5f77ce2b97ca71f4d9dd82208f4ea85b2c2b6f6275cb0deebd995b4de47830f084eda7314e12ad094
-  data.tar.gz: 7bc18322661d154e74c1133978efa7addad88c1e86b14b8d6a3eea41e6bd5c70775f12f6c641107df2818dc51468ad93bd6703f1c6b27a713659355af788882f
+  metadata.gz: 17260eb6ab5f9591ae7b986ee866abbd1b6e4182e55424de8b5a75011d7efbb741a33e191aa7a069b41d0b797b25067ae7c19fb520a64b9fdc932a0817d30b8d
+  data.tar.gz: eaff58d31ec7c5464c079209b667b8f933f44a72cbab00da3e509903c379dcbdb25fdafb914e79364e2c55f5c49de4010d37b8b186a1f9d0ff62f35cce2fd3a6

data/README.md

@@ -15,37 +15,13 @@ Extremely opinionated generator for your [Sinatra](http://www.sinatrarb.com/) ap
 * [Rspec](http://rspec.info/)
 * [Jasmine](http://jasmine.github.io/2.0/introduction.html)
 * [Bootstrap](http://getbootstrap.com/)
+* An MIT License file
 
 Should work fine for both RVM- and rbenv-based setups
 
     $ gem install skellington
-    $ skellington generate naming-things-is-hard
-    Generating naming_things_is_hard/Gemfile...done
-    Generating naming_things_is_hard/Guardfile...done
-    Generating naming_things_is_hard/Rakefile...done
-    Generating naming_things_is_hard/Procfile...done
-    Generating naming_things_is_hard/.ruby-version...done
-    Generating naming_things_is_hard/.rspec...done
-    Generating naming_things_is_hard/.gitignore...done
-    Generating naming_things_is_hard/config.ru...done
-    Generating naming_things_is_hard/features/naming_things_is_hard.feature...done
-    Generating naming_things_is_hard/features/json.feature...done
-    Generating naming_things_is_hard/features/step_definitions/naming_things_is_hard_steps.rb...done
-    Generating naming_things_is_hard/features/support/env.rb...done
-    Generating naming_things_is_hard/lib/naming_things_is_hard.rb...done
-    Generating naming_things_is_hard/lib/naming_things_is_hard/racks.rb...done
-    Generating naming_things_is_hard/lib/naming_things_is_hard/helpers.rb...done
-    Generating naming_things_is_hard/views/default.erb...done
-    Generating naming_things_is_hard/views/index.erb...done
-    Generating naming_things_is_hard/views/includes/header.erb...done
-    Generating naming_things_is_hard/spec/spec_helper.rb...done
-    Generating naming_things_is_hard/spec/naming_things_is_hard/naming_things_is_hard_spec.rb...done
-    Generating naming_things_is_hard/spec/javascripts/support/jasmine.yml...done
-    Generating naming_things_is_hard/spec/javascripts/support/jasmine_helper.rb...done
-    Generating naming_things_is_hard/spec/javascripts/naming_things_is_hardSpec.js...done
-    Generating naming_things_is_hard/public/assets/favicon.ico...done
-    Generating naming_things_is_hard/public/css/styles.css...done
-    Generating naming_things_is_hard/public/js/naming_things_is_hard.js...done
+    $ skellington generate naming-things-is-hard --licensee 'Beyoncé'
+    Generating <lots of stuff>... done
 
     Your new Sinatra app NamingThingsIsHard has been created
 
@@ -66,6 +42,10 @@ Should work fine for both RVM- and rbenv-based setups
 
       rackup
 
+    For post-install hints, try
+
+      skellington postinstall
+
 This assumes a bunch of things, at least:
 
 * That you have a reasonable git installation

data/config/config.yaml

@@ -24,6 +24,7 @@ gems:
 
 files:
   Gemfile:
+  LICENSE.md:
   Guardfile:
   Rakefile:
   Procfile:

data/lib/skellington/cli.rb

@@ -7,9 +7,34 @@ module Skellington
     map %w(-v --version) => :version
 
     desc 'generate some_path', 'Generate a skeleton Sinatra app named SomePath at some_path'
+    method_option :licensee,
+                  aliases: '-l',
+                  description: 'Name to insert into the license file'
     def generate wormname
       @g = Generator.new wormname
+      @g.licensee = options[:licensee]
       @g.run
     end
+
+    desc 'postinstall', 'Show some helpful hints'
+    def postinstall
+      s = 'Some other things you might find useful (sweeten to taste):'
+      s << "\n\n"
+      s << '* Set up continuous integration in Travis:'
+      s << "\n\n"
+      s << '    travis init'
+      s << "\n\n"
+      s << '* Configure a Heroku app:'
+      s << "\n\n"
+      s << "    heroku apps:create YOUR-APP-NAME-HERE --region=eu"
+      s << "\n\n"
+      s << '* Get Travis to continuously deploy to Heroku:'
+      s << "\n\n"
+      s << '    travis setup heroku'
+      s << "\n\n"
+      s << "(This all depends on you having Travis and Heroku installed and configured)"
+
+      puts s
+    end
   end
 end

data/lib/skellington/generator.rb

@@ -1,6 +1,7 @@
 module Skellington
   class Generator
     attr_reader :path, :filename, :camelname, :files, :gems
+    attr_accessor :licensee
 
     def initialize path
       @full_path = path

data/lib/skellington/version.rb

@@ -1,3 +1,3 @@
 module Skellington
-  VERSION = '0.4.9'
+  VERSION = '0.4.10'
 end

data/lib/templates/LICENSE.md.eruby

@@ -0,0 +1,27 @@
+<% if @gen.licensee %>
+  <% l = @gen.licensee %>
+<% else %>
+  <% l = 'YOUR-NAME-HERE' %>
+<% end %>
+##Copyright (c) <%= Time.new.strftime "%Y" %> <%= l %>
+
+#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/lib/templates/post-run.eruby

@@ -19,3 +19,11 @@ And presuming that passes OK
 You can run the app with
 
     bundle exec rackup
+<% unless @gen.licensee %>
+
+You should also fill in your name in LICENSE.md
+<% end %>
+
+For post-install hints, try
+
+    skellington postinstall

data/skellington.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'guard-rspec', '~> 4.5'
   spec.add_development_dependency 'curacao', '~> 0.1'
+  spec.add_development_dependency 'timecop', '~> 0.8'
 end

data/spec/cli/license_spec.rb

@@ -0,0 +1,74 @@
+module Skellington
+  describe CLI do
+    let :subject do
+      described_class.new
+    end
+
+    context 'generate a LICENSE' do
+      it 'plain license' do
+        Timecop.freeze Time.local 2016, 01, 19
+        subject.generate 'dummy_app'
+        expect('dummy_app/LICENSE.md').to have_content (
+        """
+        ##Copyright (c) 2016 YOUR-NAME-HERE
+
+        #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.
+        """
+        )
+        Timecop.return
+      end
+
+      it 'with a provided name' do
+        Timecop.freeze Time.local 2016, 01, 19
+        subject.options = {licensee: 'Beyoncé'}
+        subject.generate 'dummy_app'
+        expect('dummy_app/LICENSE.md').to have_content (
+        """
+        ##Copyright (c) 2016 Beyoncé
+
+        #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.
+        """
+        )
+        Timecop.return
+      end
+    end
+  end
+end

data/spec/cli_spec.rb

@@ -26,6 +26,36 @@ And presuming that passes OK
 You can run the app with
 
     bundle exec rackup
+
+You should also fill in your name in LICENSE.md
+
+For post-install hints, try
+
+    skellington postinstall
+/).to_stdout
+    end
+
+    it 'suppresses the LICENSE help when supplied with a licensee' do
+      subject.options = {licensee: 'Beyoncé'}
+      expect { subject.generate 'dummy_app' }.to_not output(/
+      You should also fill in your name in LICENSE.md
+/).to_stdout
+    end
+
+    it 'gives helpful post-generate advice' do
+      expect { subject.postinstall }.to output(/Some other things you might find useful \(sweeten to taste\):
+
+\* Set up continuous integration in Travis:
+
+    travis init
+
+\* Configure a Heroku app:
+
+    heroku apps:create YOUR-APP-NAME-HERE --region=eu
+
+\* Get Travis to continuously deploy to Heroku:
+
+    travis setup heroku
 /).to_stdout
     end
   end

data/spec/spec_helper.rb

@@ -1,6 +1,7 @@
 require 'skellington'
 require 'coveralls'
 require 'curacao'
+require 'timecop'
 
 Coveralls.wear_merged!
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skellington
 version: !ruby/object:Gem::Version
-  version: 0.4.9
+  version: 0.4.10
 platform: ruby
 authors:
 - pikesley
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 description: Generate tedious Cucumber and Sinatra boilerplate like a boss
 email:
 - sam@pikesley.org
@@ -166,6 +180,7 @@ files:
 - lib/templates/.ruby-version.eruby
 - lib/templates/Gemfile.eruby
 - lib/templates/Guardfile.eruby
+- lib/templates/LICENSE.md.eruby
 - lib/templates/Procfile.eruby
 - lib/templates/Rakefile.eruby
 - lib/templates/config.ru.eruby
@@ -197,6 +212,7 @@ files:
 - spec/cli/git_spec.rb
 - spec/cli/guardfile_spec.rb
 - spec/cli/javascript_spec.rb
+- spec/cli/license_spec.rb
 - spec/cli/non_local_path_spec.rb
 - spec/cli/procfile_spec.rb
 - spec/cli/public_spec.rb
@@ -240,6 +256,7 @@ test_files:
 - spec/cli/git_spec.rb
 - spec/cli/guardfile_spec.rb
 - spec/cli/javascript_spec.rb
+- spec/cli/license_spec.rb
 - spec/cli/non_local_path_spec.rb
 - spec/cli/procfile_spec.rb
 - spec/cli/public_spec.rb