kickster 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a8940d0d64659eccdb310b48240ec3c3025357ad
-  data.tar.gz: a2de7704ee189ae3554aac5a32eed242e3093648
+  metadata.gz: 4ac58d83017de50db4f432b141d51bce5e3e3a48
+  data.tar.gz: ffedf17081bbbdb3cfbb519fc270f468e114a5ee
 SHA512:
-  metadata.gz: 8b2d2fa7ab0b91d2ea768c6f71d9417b8b1e8f3a1a241339e3c8c099a18626b7aabe0a7e88c61300eb483dfac52591898e54e12bedc82c7cfaa0f6c7e64a0e1a
-  data.tar.gz: 253bb11b8ebed9292691a0d5e1a3fe3cebd98dfd28ca5addaf39cd10db647c130ee6847cce7a5a7d0423d3c403e2a16c7996b86126672b662367d30427ca373e
+  metadata.gz: a4e5e91bbedfafae7a36d450177329f2e0afcbbeb8c74c92d583f6bc6ab05cf7935e987cdcc1f18f32b906e742470f15ff4ab07414364ff86fc1a8905e5f4939
+  data.tar.gz: e088495db8749a01a5b227b832c63839333e4efd74ad71ee18a102de2bee73a308a86b3945f95fa219088c20a0762d074ddbc0d3c393b9a203320b3a51f6c545

data/.gitignore

@@ -9,3 +9,4 @@
 /tmp/
 *.DS_Store
 *.sass-cache
+*.gem

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in kickster.gemspec
 gemspec

data/README.md

@@ -1,4 +1,5 @@
-# kickster
+Kickster
+========
 
 Jekyll starter template with GitHub Pages deploy to kickstart your project.
 
@@ -27,7 +28,7 @@ Run Jekyll
     bundle exec jekyll serve --watch
 
 Used tools:
-  - [Jekyll assets](http://ixti.net/jekyll-assets/)
+  - [Jekyll assets](https://github.com/jekyll/jekyll-assets)
   - [Bower](http://bower.io/)
   - [Jekyll](http://jekyllrb.com/)
   - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
@@ -56,3 +57,5 @@ MIT License
 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
+
+Big thanks to [@wouterw](https://github.com/wouterw) for helping out with his Ruby magic.

data/bin/kickster

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
 
-require File.dirname(__FILE__) + '/../lib/kickster.rb'
-
+require File.dirname(__FILE__) + "/../lib/kickster.rb"
 Kickster::Generator.start

data/kickster.gemspec

@@ -1,19 +1,22 @@
+$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+require "kickster/version"
+
 Gem::Specification.new do |spec|
   spec.name          = "kickster"
-  spec.version       = "0.1.2"
+  spec.version       = Kickster::VERSION
   spec.platform      = Gem::Platform::RUBY
   spec.author        = "Nielsen Ramon"
   spec.summary       = "Hassle-free deploying to GitHub Pages with Jekyll."
   spec.description   = "Jekyll starter template with GitHub Pages deploy to kickstart your project."
   spec.email         = "nielsenramon1@gmail.com"
-  spec.homepage      = "http://nielsenramon.com/kickster"
+  spec.homepage      = "http://kickster.nielsenramon.com/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency("thor")
+  spec.add_runtime_dependency("thor", "~> 0")
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
 end

data/lib/kickster.rb

@@ -1,2 +1,6 @@
-require "kickster/generator"
-require "kickster/version"
+require_relative "kickster/version"
+require_relative "kickster/install"
+require_relative "kickster/generator"
+
+module Kickster
+end

data/lib/kickster/generator.rb

@@ -1,57 +1,16 @@
-require "fileutils"
-require "kickster/version"
-require "pathname"
 require "thor"
 
 module Kickster
   class Generator < Thor
-    map ['-v', '--version'] => :version
+    include Thor::Actions
 
-    desc 'new', 'Create new folder with the Kickster template'
-    method_options :path => :string, :force => :boolean
-    def new(name)
-      if kickster_files_already_exist?(name) && !options[:force]
-        puts "Folder already exist, use --force to overwrite."
-      else
-        install_files(name)
-        puts "Kickster template folder successfully created!"
-      end
-    end
+    map ["-v", "--version"] => :version
 
-    desc 'version', 'Show Kickster version'
+    desc "version", "Show Kickster version"
     def version
-      say "kickster-#{Kickster::VERSION}"
-    end
-
-    private
-
-    def kickster_files_already_exist?(name)
-      install_path(name).exist?
+      say "Kickster #{Kickster::VERSION}"
     end
 
-    def install_path(name)
-      @install_path ||= if options[:path]
-        Pathname.new(File.join(options[:path], name))
-      else
-        Pathname.new(name)
-      end
-    end
-
-    def install_files(name)
-      FileUtils.mkdir_p(install_path(name))
-      FileUtils.cp_r(template_files, install_path(name))
-    end
-
-    def template_files
-      Dir["#{template_directory}/."]
-    end
-
-    def template_directory
-      File.join(top_level_directory, "template")
-    end
-
-    def top_level_directory
-      File.dirname(File.dirname(File.dirname(__FILE__)))
-    end
+    register(Kickster::Install, "new", "new", "Create new folder with the Kickster template")
   end
 end

data/lib/kickster/install.rb

@@ -0,0 +1,41 @@
+require "thor"
+
+module Kickster
+  class Install < Thor::Group
+    include Thor::Actions
+
+    argument :name
+    class_options force: :boolean
+
+    def self.source_root
+      File.expand_path("../../../template", __FILE__)
+    end
+
+    def name_components
+      @_name_components ||= name.scan(/[[:alnum:]]+/)
+    end
+
+    def snake_name
+      @_snake_name = name_components.map(&:downcase).join("_")
+    end
+
+    def camel_name
+      @_camel_name = name_components.map(&:capitalize).join("")
+    end
+
+    def check_if_exists?
+      if File.directory?(snake_name) && !options[:force]
+        say "Folder already exist, use --force to overwrite.", :red
+        exit 1
+      end
+    end
+
+    def copy_templates
+      directory("./", "./#{snake_name}")
+    end
+
+    def report_success
+      say "Kickster template folder successfully created!", :green
+    end
+  end
+end

data/lib/kickster/version.rb

@@ -1,3 +1,3 @@
 module Kickster
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/template/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.2.3

data/template/Gemfile

@@ -1,8 +1,8 @@
 source "https://rubygems.org"
 
-gem "autoprefixer-rails"
-gem "jekyll"
-gem "jekyll-assets"
-gem "jekyll-sitemap"
-gem "sass"
-gem "uglifier"
+gem "autoprefixer-rails", "~> 6.1", ">= 6.1.0.1"
+gem "jekyll", "~> 3.0", ">= 3.0.1"
+gem "jekyll-assets", "~> 2.0"
+gem "jekyll-sitemap", "~> 0.9.0"
+gem "sass", "~> 3.4", ">= 3.4.19"
+gem "uglifier", "~> 2.7", ">= 2.7.2"

data/template/README.md.tt

@@ -0,0 +1,26 @@
+# <%= camel_name %>
+
+### Installation
+
+Set up your environment
+
+    bin/setup
+
+### Development
+
+Run Jekyll
+
+    bundle exec jekyll serve --watch
+
+Used tools:
+  - [Jekyll assets](http://ixti.net/jekyll-assets/)
+  - [Bower](http://bower.io/)
+  - [Jekyll](http://jekyllrb.com/)
+  - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
+  - [Autoprefixer](https://github.com/postcss/autoprefixer)
+
+### Deploy to GitHub Pages
+
+Run this script and add a customized deploy message:
+
+    bin/deploy "custom_message"

data/template/{_config.yml → _config.yml.tt}

@@ -1,4 +1,5 @@
 permalink: pretty
+name: <%= snake_name %>
 
 exclude:
   - .bowerrc
@@ -10,9 +11,6 @@ exclude:
   - bin/*
 
 assets:
-  dirname: assets
-  baseurl: /assets/
-
   sources:
     - _assets/fonts
     - _assets/images
@@ -20,12 +18,8 @@ assets:
     - _assets/stylesheets
     - _vendor/
 
-  js_compressor: uglifier
-  css_compressor: sass
-  gzip: false
-  debug: true
-
 baseurl: /
+url: /
 
 gems:
   - jekyll-assets

data/template/_layouts/default.html

@@ -4,23 +4,24 @@
   <meta charset="utf-8">
   <meta http-equiv="x-ua-compatible" content="ie=edge">
 
-  <title>{{ page.title }}</title>
+  <title>{{ site.name }} | {{ page.title }}</title>
 
   <meta name="description" content="{{ page.description }}">
   <meta name="viewport" content="width=device-width, initial-scale=1">
-  <meta name="author" content="">
 
   <meta property="og:title" content="{{ page.title }}">
-  <meta property="og:url" content="{{ site.baseurl }}">
+  <meta property="og:url" content="{{ site.url }}">
   <meta property="og:description" content="{{ page.description }}">
-  <meta property="og:site_name" content="">
-  <meta property="og:image" content="{{ site.assets.baseurl }}">
+  <meta property="og:site_name" content="{{ site.name }}">
+  <meta property="og:image" content="">
 
   <meta name="twitter:card" content="summary">
-  <meta name="twitter:url" content="{{ site.baseurl }}">
+  <meta name="twitter:url" content="{{ site.url }}">
   <meta name="twitter:title" content="{{ page.title }}">
   <meta name="twitter:description" content="{{ page.description }}">
-  <meta name="twitter:image" content="{{ site.assets.baseurl }}">
+  <meta name="twitter:image" content="">
+
+  <link rel="apple-touch-icon" href="apple-touch-icon.png">
 
   {% stylesheet application %}
 </head>

data/template/{bower.json → bower.json.tt}

@@ -1,5 +1,5 @@
 {
-  "name": "kickster",
+  "name": "<%= snake_name %>",
   "dependencies": {
     "jquery": "~1.11.2"
   }

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: kickster
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Nielsen Ramon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-21 00:00:00.000000000 Z
+date: 2015-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
@@ -69,31 +69,31 @@ files:
 - kickster.gemspec
 - lib/kickster.rb
 - lib/kickster/generator.rb
+- lib/kickster/install.rb
 - lib/kickster/version.rb
 - template/.bowerrc
 - template/.gitignore
 - template/.ruby-version
-- template/.scss-lint.yml
 - template/404.html
 - template/Gemfile
-- template/README.md
+- template/README.md.tt
 - template/_assets/fonts/.keep
 - template/_assets/images/.keep
 - template/_assets/javascripts/application.js
 - template/_assets/javascripts/vendor.js
 - template/_assets/stylesheets/application.scss
-- template/_config.yml
-- template/_data/fixtures.yml
+- template/_config.yml.tt
+- template/_data/.keep
 - template/_includes/.keep
 - template/_layouts/default.html
-- template/apple-touch-icon-precomposed.png
+- template/apple-touch-icon.png
 - template/bin/deploy
 - template/bin/setup
-- template/bower.json
+- template/bower.json.tt
 - template/favicon.ico
 - template/index.html
 - template/robots.txt
-homepage: http://nielsenramon.com/kickster
+homepage: http://kickster.nielsenramon.com/
 licenses:
 - MIT
 metadata: {}

data/template/.scss-lint.yml

@@ -1,22 +0,0 @@
-exclude:
-  - ''
-
-linters:
-  StringQuotes:
-    enabled: true
-    style: double_quotes
-
-  UrlFormat:
-    enabled: false
-
-  SelectorDepth:
-    enabled: true
-    max_depth: 4
-
-  PropertySortOrder:
-    enabled: true
-    order: recess
-
-  NestingDepth:
-    enabled: true
-    max_depth: 4

data/template/README.md

@@ -1,43 +0,0 @@
-kickster
-========
-
-Jekyll starter template with GitHub Pages deploy to kickstart your project.
-
-### Installation
-
-Set up your environment
-
-    bin/setup
-
-Update `baseurl` and `assets:baseurl` in `_config.yml` with the correct path.
-
-*If you do not want the Kickster files but just the deploy then copy `bin/setup` script to your repo and your ready to go.*
-
-### Development
-
-Run Jekyll
-
-    bundle exec jekyll serve --watch
-
-Used tools:
-  - [Jekyll assets](http://ixti.net/jekyll-assets/)
-  - [Bower](http://bower.io/)
-  - [Jekyll](http://jekyllrb.com/)
-  - Influences from [HTML5 Boilerplate](https://html5boilerplate.com/)
-  - [Autoprefixer](https://github.com/postcss/autoprefixer)
-
-### Deploy to GitHub Pages
-
-Run this script and add a customized deploy message:
-
-    bin/deploy "custom_message"
-
-### Why
-
-Setting up GitHub Pages websites with Jekyll for projects or clients is cumbersome as you have to setup everything from scratch. Kickster helps you kickstart your project settling you with a basic starter template and easy deploy. Deploying is completed in 1 second so updating your website or prototype is a breeze.
-
-You can find example project [here](https://github.com/nielsenramon/kickster/tree/website).
-
-### License
-
-MIT License