skellington 0.8.3 → 0.8.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7fa8054ba525d6331053badd6a6bf85b67a4f227
-  data.tar.gz: 72b3ac473d0c0610d1577d6d287bc51e307ba25e
+  metadata.gz: 6aad5990c93118d8b43591b5ebc788a0e747f71e
+  data.tar.gz: ec85c14f2c888ddf9e2d7fc78adcb7eeb4532e3b
 SHA512:
-  metadata.gz: a413c46c080d78fee84e2dd1a39d792a8b39ff6aae437f5196ad06f8d5aaaa060d7ad272f704d512ad02007bcff83caf41a5f0c92347c1111ca036288450e676
-  data.tar.gz: 02a80db9145cf3ee0f40eea2e251f7317f7caa29c9bcbb3f17d76540fb4db49f41b2792f8d4125cd8807b49b8651dbd7e8ebcd37bf6e99d0541172b930f5aa09
+  metadata.gz: 00b595a0fc9a5af1e5366cb5da30909ad2a3750c608cafdc005caa16ec493df87b9b4fc3d3e6c78153ba090730b98619d109bf1169462d0fa2c2614173032630
+  data.tar.gz: 0ebb4702c17878374a9fcb6bf9ca18d856621f19c9f735b751c413bd4286fe9a6c4af9353dc2dea466f57743bc0cbcadbc580cef7f0061abfa2858d2b8f2f270

data/config/config.yaml

@@ -19,6 +19,13 @@ sinatra:
       pry:
       actionpack:
 
+# for a $file in the list below, skellington looks for templates first in
+# $framework/templates/$file, then in common/templates at the $common path
+# if that's specified for $file, then at common/templates/$file. if it never
+# gets a match, it creates an empty file at $file
+#
+# I will never be able to support a web framework called 'common'
+
   files:
     Gemfile:
     LICENSE.md:
@@ -28,7 +35,6 @@ sinatra:
     .ruby-version:
     .rspec:
     .gitignore:
-      common: gitignore
     config.ru:
     config.rb:
     config/config.yml:
@@ -44,6 +50,7 @@ sinatra:
     views/layout.erb:
       common: views/layout
     views/index.erb:
+    views/oops.erb:
     views/includes/header.erb:
       common: includes/header
     views/includes/footer.erb:
@@ -65,19 +72,24 @@ sinatra:
       outpath: app/wormname
     public/assets/favicon.ico:
     public/css/styles.css:
+      common: css/styles
     public/js/app.js:
       outpath: app/wormname
+      common: js/app.js
     public/sass/_footer.scss:
-      common: sass/footer.scss
+      common: sass/footer
     public/sass/_fonts.scss:
-      common: sass/fonts.scss
+      common: sass/fonts
     public/sass/_github-corner.scss:
+      common: sass/github-corner
     public/sass/_variables.scss:
-      common: sass/variables.scss
+      common: sass/variables
+    public/sass/palettes/_default.scss:
+      common: sass/palettes/default
     public/sass/_colours.scss:
-      common: sass/colours.scss
+      common: sass/colours
     public/sass/styles.scss:
-      common: sass/styles.scss
+      common: sass/styles
 
 jekyll:
   gems:
@@ -89,8 +101,8 @@ jekyll:
     Gemfile:
     _config.yml:
     .gitignore:
-      common: gitignore
     index.md:
+    404.md:
     _layouts/default.html:
       common: views/layout
     _includes/header.html:
@@ -100,15 +112,21 @@ jekyll:
     _includes/ie-cruft.html:
       common: includes/ie-cruft
     css/styles.scss:
-      common: sass/styles.scss
+      common: sass/styles
     _sass/variables.scss:
-      common: sass/variables.scss
+      common: sass/variables
     _sass/colours.scss:
-      common: sass/colours.scss
+      common: sass/colours
+    _sass/palettes/default.scss:
+      common: sass/palettes/default
     _sass/fonts.scss:
-      common: sass/fonts.scss
+      common: sass/fonts
     _sass/footer.scss:
-      common: sass/footer.scss
+      common: sass/footer
+    assets/favicon.ico:
     LICENSE.md:
     .ruby-version:
     _data/libs.yml:
+    js/app.js:
+      outpath: app/wormname
+      common: js/app.js

data/lib/common/templates/includes/header

@@ -31,7 +31,7 @@
 
   <link rel='icon' type='image/png' href='<%= prefix %>/assets/favicon.ico' />
   <link rel='stylesheet' href='<%= prefix %>/css/styles.css' />
-  <script src='<%= prefix %>/js/dummy_app.js'></script>
+  <script src='<%= prefix %>/js/<%= @gen.wormname %>.js'></script>
   <title>
   <% case @gen.framework %>
   <% when 'sinatra' %>

data/lib/common/templates/sass/colours

@@ -0,0 +1,10 @@
+@import 'palettes/default';
+
+$brand-primary: $rgba-primary-0;
+//$brand-complement: $rgba-complement-0;
+//$brand-secondary-1: $rgba-secondary-1-0;
+//$brand-secondary-2: $rgba-secondary-2-0;
+
+$grey: rgb(127, 127, 127);
+$light-grey: lighten($grey, 25%);
+$dark-grey: darken($grey, 25%);

data/lib/common/templates/sass/palettes/default

@@ -0,0 +1,67 @@
+// drop a Sass export of a Paletton (http://paletton.com/) palette in here
+
+// SASS style sheet */
+// Palette color codes */
+// Palette URL: http://paletton.com/#uid=75b100kw0w0jyC+oRxVy4oIDfjr */
+
+// Feel free to copy&paste color codes to your application */
+
+
+// As hex codes */
+
+$color-primary-0: #CE0071;	// Main Primary color */
+$color-primary-1: #DA559E;
+$color-primary-2: #D12F87;
+$color-primary-3: #9F0057;
+$color-primary-4: #7D0044;
+
+$color-secondary-1-0: #FF7F00;	// Main Secondary color (1) */
+$color-secondary-1-1: #FFB163;
+$color-secondary-1-2: #FF9B39;
+$color-secondary-1-3: #C56200;
+$color-secondary-1-4: #9B4D00;
+
+$color-secondary-2-0: #04819E;	// Main Secondary color (2) */
+$color-secondary-2-1: #4AA2B6;
+$color-secondary-2-2: #288CA4;
+$color-secondary-2-3: #03637A;
+$color-secondary-2-4: #024E60;
+
+$color-complement-0: #9BED00;	// Main Complement color */
+$color-complement-1: #BFF25E;
+$color-complement-2: #AFEE35;
+$color-complement-3: #78B700;
+$color-complement-4: #5E9000;
+
+
+
+// As RGBa codes */
+
+$rgba-primary-0: rgba(206,  0,113,1);	// Main Primary color */
+$rgba-primary-1: rgba(218, 85,158,1);
+$rgba-primary-2: rgba(209, 47,135,1);
+$rgba-primary-3: rgba(159,  0, 87,1);
+$rgba-primary-4: rgba(125,  0, 68,1);
+
+$rgba-secondary-1-0: rgba(255,127,  0,1);	// Main Secondary color (1) */
+$rgba-secondary-1-1: rgba(255,177, 99,1);
+$rgba-secondary-1-2: rgba(255,155, 57,1);
+$rgba-secondary-1-3: rgba(197, 98,  0,1);
+$rgba-secondary-1-4: rgba(155, 77,  0,1);
+
+$rgba-secondary-2-0: rgba(  4,129,158,1);	// Main Secondary color (2) */
+$rgba-secondary-2-1: rgba( 74,162,182,1);
+$rgba-secondary-2-2: rgba( 40,140,164,1);
+$rgba-secondary-2-3: rgba(  3, 99,122,1);
+$rgba-secondary-2-4: rgba(  2, 78, 96,1);
+
+$rgba-complement-0: rgba(155,237,  0,1);	// Main Complement color */
+$rgba-complement-1: rgba(191,242, 94,1);
+$rgba-complement-2: rgba(175,238, 53,1);
+$rgba-complement-3: rgba(120,183,  0,1);
+$rgba-complement-4: rgba( 94,144,  0,1);
+
+
+
+// Generated by Paletton.com © 2002-2014 */
+// http://paletton.com */

data/lib/jekyll/templates/404.md

@@ -0,0 +1,6 @@
+---
+title: 404
+permalink: /404.html
+---
+
+# Nothing to see here

data/lib/jekyll/templates/{_config.yml.eruby → _config.yml}

@@ -6,4 +6,4 @@ defaults:
     layout: default
 permalink: pretty
 
-baseurl: /<%= @gen.wormname %>
+baseurl: /<%= @gen.originalname %>

data/lib/jekyll/templates/{post-run.eruby → post-run}

@@ -2,7 +2,7 @@
 Your new Jekyll site <%= @gen.camelname %> has been created
 
 <% if @gen.renamed %>
-(Note that '<%= @gen.filename %>' has been changed to '<%= @gen.wormname %>' because Ruby finds '-'s troubling)
+(Note that '<%= @gen.originalname %>' has been changed to '<%= @gen.wormname %>' because Ruby finds '-'s troubling)
 
 <% end %>
 Now do
@@ -11,7 +11,7 @@ Now do
     bundle
     bundle exec jekyll serve
 
-which will launch the site (at http://localhost:4000/<%= @gen.wormname %>/)
+which will launch the site (at http://localhost:4000/<%= @gen.originalname %>/)
 
 And presuming that works OK
 

data/lib/sinatra/templates/{Rakefile.eruby → Rakefile}

@@ -12,8 +12,14 @@ unless ENV['RACK_ENV'] == 'production'
   task :default => [:spec, 'jasmine:ci', 'coveralls:push']
 end
 
-task :run do
-  sh 'bundle exec compass clean'
-  sh 'bundle exec compass watch . &'
-  sh 'bundle exec rackup'
+namespace :run do
+  desc 'start app'
+  task :app do
+    sh 'rackup -o 0.0.0.0'
+  end
+
+  desc 'clean-up and run compass'
+  task :sass do
+    sh 'compass clean && compass watch'
+  end
 end

data/lib/sinatra/templates/config/config.yml

@@ -0,0 +1,2 @@
+#google-analytics-tag: UA-00000000-0
+#github_url: https://github.com # also uncomment the `include` line in `styles.scss`

data/lib/sinatra/templates/lib/{app.rb.eruby → app.rb}

@@ -33,5 +33,11 @@ module <%= @gen.camelname %>
 
     # start the server if ruby file executed directly
     run! if app_file == $0
+
+    not_found do
+      status 404
+      @title = '404'
+      erb :oops
+    end
   end
 end

data/lib/sinatra/templates/{post-run.eruby → post-run}

@@ -16,9 +16,10 @@ And presuming that passes OK
     git add .
     git commit -m 'First commit'
 
-Then try
+Then try (in 2 different windows)
 
-    bundle exec rake run
+    bundle exec rake run:sass
+    bundle exec rake run:app
 
 which will launch Compass and then run the app (at http://localhost:9292)
 <% unless @gen.licensor %>

data/lib/sinatra/templates/views/oops.erb

@@ -0,0 +1,5 @@
+<h1>404</h1>
+
+<h2>Nothing to see here</h2>
+
+<a href='/'>Home</a>

data/lib/skellington/cli.rb

@@ -10,10 +10,7 @@ module Skellington
     method_option :framework,
                   default: 'sinatra',
                   description: 'Framework to generate for',
-                  enum: [
-                    'sinatra',
-                    'jekyll'
-                  ]
+                  enum: ['sinatra', 'jekyll']
     method_option :bootstrap,
                   default: '3',
                   description: 'Bootstrap major version to use',

data/lib/skellington/generator.rb

@@ -1,6 +1,13 @@
 module Skellington
   class Generator
-    attr_reader :path, :filename, :camelname, :files, :gems, :framework, :bootstrap
+    attr_reader :path,
+                :filename,
+                :originalname,
+                :camelname,
+                :files,
+                :gems,
+                :framework,
+                :bootstrap
     attr_accessor :licensor
 
     def initialize path, options = {}
@@ -9,6 +16,7 @@ module Skellington
       @full_path = path
       @path = File.dirname @full_path
       @filename = File.basename(@full_path)
+      @originalname = @filename
       @camelname = Skellington.camelise(wormname)
       @gems = config[@framework]['gems']
       @files = config[@framework]['files']
@@ -46,10 +54,6 @@ module Skellington
 
         root = "#{self.path}/#{self.wormname}"
 
-      #  FileUtils.mkdir_p "#{root}/javascripts"
-      #  FileUtils.cp_r "#{Bootstrap.assets_path}/javascripts/bootstrap", "#{root}/javascripts"
-      #  FileUtils.cp "#{Bootstrap.assets_path}/javascripts/bootstrap.min.js", "#{root}/javascripts"
-
         FileUtils.mkdir_p "#{root}/_sass"
         FileUtils.cp_r "#{Bootstrap.assets_path}/stylesheets/bootstrap", "#{root}/_sass"
         FileUtils.cp "#{Bootstrap.assets_path}/stylesheets/_bootstrap.scss", "#{root}/_sass/bootstrap.scss"
@@ -57,7 +61,7 @@ module Skellington
     end
 
     def wormname
-      @filename.gsub('-', '_')
+      @wormname ||= @filename.gsub('-', '_')
     end
 
     def renamed

data/lib/skellington/template.rb

@@ -31,23 +31,20 @@ module Skellington
       puts 'done'
     end
 
-    def to_s
-      path = "#{templates_dir}/#{@name}.eruby"
-      if @generator.files.dig(@name, 'common')
-        path = "#{common_templates}/#{@generator.files[@name]['common']}"
+    def path
+      [
+        "#{templates_dir}/#{@name}",
+        "#{common_templates}/#{@generator.files.dig(@name, 'common')}",
+        "#{common_templates}/#{@name}"
+      ].each do |maybe_path|
+        return File.read(File.open(maybe_path)) if File.file? maybe_path
       end
 
-      begin
-        t = File.read(File.open(path))
+      ''
+    end
 
-        # this can go away soon
-        if t =~ /^common: (.*)$/
-          t = File.read(File.open("#{common_templates}/#{$1}"))
-        end
-      rescue Errno::ENOENT
-        t = File.read(File.open("#{common_templates}/#{@name}.eruby"))
-      end
-      Erubis::Eruby.new(t).evaluate(gen: @generator)
+    def to_s
+      Erubis::Eruby.new(path).evaluate(gen: @generator)
     end
   end
 end

data/lib/skellington/version.rb

@@ -1,3 +1,3 @@
 module Skellington
-  VERSION = '0.8.3'
+  VERSION = '0.8.4'
 end

data/spec/hyphens_spec.rb

@@ -25,9 +25,6 @@ And presuming that passes OK
     git add .
     git commit -m 'First commit'
 
-Then try
-
-    bundle exec rake run
 /).to_stdout
 
       expect(File).to exist 'hyphenated_name/lib/hyphenated_name.rb'

data/spec/jekyll/404_spec.rb

@@ -0,0 +1,23 @@
+module Skellington
+  describe CLI do
+    let :subject do
+      described_class.new
+    end
+
+    it 'has a 404 page' do
+      subject.options = { 'framework' => 'jekyll' }
+      subject.generate 'dummy-app'
+
+      expect('dummy_app/404.md').to have_content (
+      """
+      ---
+      title: 404
+      permalink: /404.html
+      ---
+
+      # Nothing to see here
+      """
+      )
+    end
+  end
+end

data/spec/jekyll/assets/static_spec.rb

@@ -0,0 +1,14 @@
+module Skellington
+  describe CLI do
+    let :subject do
+      described_class.new
+    end
+
+    it 'creates a favicon' do
+      subject.options = { 'framework' => 'jekyll' }
+      subject.generate 'dummy-app'
+
+      expect(File).to exist 'dummy_app/assets/favicon.ico'
+    end
+  end
+end

data/spec/jekyll/bootstrap/css_spec.rb

@@ -6,7 +6,7 @@ module Skellington
 
     it 'installs bootstrap' do
       subject.options = { 'framework' => 'jekyll' }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
 
       expect('dummy_app/_sass/bootstrap.scss').to have_content (
       """
@@ -30,9 +30,19 @@ module Skellington
       """
       )
 
+      expect(File).to exist 'dummy_app/_sass/palettes/default.scss'
       expect('dummy_app/_sass/colours.scss').to have_content (
       """
-      $brand-primary: rgba(250, 129, 0, 1);
+      @import 'palettes/default';
+
+      $brand-primary: $rgba-primary-0;
+      //$brand-complement: $rgba-complement-0;
+      //$brand-secondary-1: $rgba-secondary-1-0;
+      //$brand-secondary-2: $rgba-secondary-2-0;
+
+      $grey: rgb(127, 127, 127);
+      $light-grey: lighten($grey, 25%);
+      $dark-grey: darken($grey, 25%);
       """
       )
 
@@ -69,7 +79,7 @@ module Skellington
 
     it 'sets up sass' do
       subject.options = { 'framework' => 'jekyll' }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
 
       expect('dummy_app/css/styles.scss').to have_content (
       """

data/spec/jekyll/bootstrap_4/bootstrap_4_spec.rb

@@ -6,7 +6,7 @@ module Skellington
 
     it 'installs bootstrap 4' do
       subject.options = { 'framework' => 'jekyll', 'bootstrap' => 4 }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
 
     #  expect(Dir).to exist 'dummy_app/javascripts/bootstrap'
     #  expect('dummy_app/javascripts/bootstrap.min.js').to have_content (
@@ -32,7 +32,16 @@ module Skellington
       )
       expect('dummy_app/_sass/colours.scss').to have_content (
       """
-      $brand-primary: rgba(250, 129, 0, 1);
+      @import 'palettes/default';
+
+      $brand-primary: $rgba-primary-0;
+      //$brand-complement: $rgba-complement-0;
+      //$brand-secondary-1: $rgba-secondary-1-0;
+      //$brand-secondary-2: $rgba-secondary-2-0;
+
+      $grey: rgb(127, 127, 127);
+      $light-grey: lighten($grey, 25%);
+      $dark-grey: darken($grey, 25%);
       """
       )
       expect('dummy_app/_sass/fonts.scss').to have_content (

data/spec/jekyll/cli_spec.rb

@@ -6,16 +6,18 @@ module Skellington
 
     it 'generates correct output' do
       subject.options = { 'framework' => 'jekyll' }
-      expect { subject.generate 'dummy_app' }.to output(/
+      expect { subject.generate 'dummy-app' }.to output(/
 Your new Jekyll site DummyApp has been created
 
+\(Note that 'dummy-app' has been changed to 'dummy_app' because Ruby finds '-'s troubling\)
+
 Now do
 
     cd dummy_app
     bundle
     bundle exec jekyll serve
 
-which will launch the site \(at http:\/\/localhost:4000\/dummy_app\/\)
+which will launch the site \(at http:\/\/localhost:4000\/dummy-app\/\)
 
 And presuming that works OK
 

data/spec/jekyll/data/libs_spec.rb

@@ -6,7 +6,7 @@ module Skellington
 
     it 'creates a libs data file' do
       subject.options = { 'framework' => 'jekyll' }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
 
       expect(Dir).to exist 'dummy_app/_data'
       expect('dummy_app/_data/libs.yml').to have_content (

data/spec/jekyll/git_spec.rb

@@ -6,7 +6,7 @@ module Skellington
 
     it 'initialises a git repo' do
       subject.options = { 'framework' => 'jekyll' }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
       expect(Dir).to exist 'dummy_app/.git'
 
       expect('dummy_app/.gitignore').to have_content (

data/spec/jekyll/{layout/index_md_spec.rb → index_md_spec.rb}

@@ -6,7 +6,7 @@ module Skellington
 
     it 'creates a default index page' do
       subject.options = { 'framework' => 'jekyll' }
-      subject.generate 'dummy_app'
+      subject.generate 'dummy-app'
 
       expect('dummy_app/index.md').to have_content (
       """

data/spec/jekyll/js/javascript_spec.rb

@@ -0,0 +1,14 @@
+module Skellington
+  describe CLI do
+    let :subject do
+      described_class.new
+    end
+
+    it 'installs bootstrap' do
+      subject.options = { 'framework' => 'jekyll' }
+      subject.generate 'dummy-app'
+
+      expect(File).to exist 'dummy_app/js/dummy_app.js'
+    end
+  end
+end