stevenson 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 283a293b67a913eb19f38d5c26e28af097f7a397
-  data.tar.gz: b030b2e3298150ff97011f35de15d382170d3c4b
+  metadata.gz: a01532f19f37e0bbd43a680127d4471c9988edae
+  data.tar.gz: 0c6ccedfe334238758c7c9e1146fb93e85212350
 SHA512:
-  metadata.gz: 9d7087c8863bb1e47c762409f3756ebabe512c93f1b1dc7276684baefe6c7bfdb438961538c8f3fc65e1d3e3098b8bc55bd633df86590d570a5eebea8f0ee771
-  data.tar.gz: f01181f0ee29f1cee4eb3c36a5d8da36d8142ad0d29fbd7480277f3092a4c4990c40ed3563dafb794e4f6d0e3fbcb7071b9640896125deff4e88d5ec6ca3f77d
+  metadata.gz: 774610b2e82f5e08bb134b231b664084f91e52b48ef4e2ecadd05f5fc71caf02da37610edfc3745cc9b719dd8ff3ff2fb3bfedd9281d741213fd03563f5cf5d8
+  data.tar.gz: 4d0bdf722f9ff79cb00d9592cd9610976a0415efdc993e4b47f143260cd76439d8da7c337349f330916579cec6ff79d66e2087b1cb7ef875ddc90e3e8662d8b4

data/README.md

@@ -13,17 +13,15 @@ generator.
 
 Add this line to your application's Gemfile:
 
-    gem 'stevenson', :git => 'git://github.com/RootsRated/stevenson.git'
+    gem 'stevenson'
 
 And then execute:
 
     $ bundle
 
-Or install it yourself with:
+Or install it globally:
 
-    $ git clone git://github.com/RootsRated/stevenson.git
-    $ cd stevenson
-    $ rake install
+    $ gem install stevenson
 
 ## Usage
 
@@ -84,19 +82,22 @@ validated as emails, validated as URLs, or limited to a certain length.
 
 Here's an example of the YAML file:
 
-    #_stevenson.yml
+    # _stevenson.yml
+
     '_config.yml':
       title:
-        question: 'Title: '
-       limit: 40
+        type: 'text'
+        prompt: 'Title: '
+        limit: 40
       email:
-        question: 'Email: '
-        email: true
+        type: 'email'
+        prompt: 'Email: '
       description:
-        question: 'Description: '
+        type: 'text'
+        prompt: 'Description: '
       url:
-        question: 'URL: '
-        url: true
+        type: 'url'
+        prompt: 'URL: '
 
 This file will produce the following questions when
 `stevenson new hello_world https://github.com/YourUsername/YourTemplate.git` is
@@ -111,17 +112,100 @@ used:
 When these questions are answered, the following will be added to
 `hello_world/_config.yml`:
 
-    #_config.yml
+    # _config.yml
+
     title: RootsRated.com
     email: info@rootsrated.com
     description: This is a microsite created by RootsRated.com
     url: http://www.rootsrated.com
 
-**The 'question' of each option is required** and will be used to ask users for
-input to replace these values.
-
-Any values already set in the `_config.yml` will be used as defaults for these
-questions.
+The `prompt` attribute defines how the user should be prompted for input, the
+`type` attribute specifies which kind of input the prompt should accept, and any
+values already set in the `_config.yml` will be used as defaults for these
+questions. Alternatively, defaults can be overriden with a `default` attribute.
+
+### Input Types
+
+There are several input types available now, and hopefully, there will be more
+in the future.
+
+#### Text
+
+The most basic input is the text input. This simply accepts a text string.
+Optionally, a limit can be added with the `limit` attribute.
+
+#### Email
+
+This input is a subclass of the text input that only accepts emails as validated
+with the following regex: `/\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i`.
+Additionally, Email has the same options as Text.
+
+#### Password
+
+This input is also a subclass of text, but unlike text, it will not output the
+input string to the console for added security.
+
+#### Url
+
+This input, another subclass of text, accepts only text that satisfies this
+regex: `/https?:\/\/[\S]+/`.
+
+#### Select
+
+This input prompts the user to choose from a list of given options. The options
+can be provided as subkeys to the `options` attribute like so:
+
+    favorite_color:
+      type: 'select'
+      prompt: 'Favorite Color: '
+      options:
+        'Red': '#FF0000'
+        'Blue': '#00FF00'
+        'Green': '#0000FF'
+
+The first value given is the value that will be offer to the user to choose. The
+second value is the value that will be written to `_config.yml`.
+
+Optionally, you can also fetch more options from a JSON API source using the
+`url`, `list_key`, `name_key`, and `value_key` attributes. `url` specifies the
+url to fetch json options from. `list_key` specifies the root element of the
+JSON document to iterate over for options. `name_key` specifies the name from
+each iterated item to use as a name. `value_key` specifies the value from each
+iterated item to use as a value. The following example is identical to the
+previous example using the `options` attribute:
+
+    # http://someapi.com/source.json
+
+    {
+      "response": [
+        {
+            "name": "Red",
+            "value": "#FF0000"
+        },
+        {
+            "name": "Blue",
+            "value": "#00FF00"
+        },
+        {
+            "name": "Green",
+            "value": "#0000FF"
+        }
+      ]
+    }
+
+    # _stevenson.yml
+
+    favorite_color:
+      type: 'select'
+      prompt: 'Favorite Color: '
+      url: 'http://someapi.com/source.json'
+      list_key: 'response'
+      name_key: 'name'
+      value_key: 'value'
+
+Additionally, remote sources and the `options` attribute can be used together.
+If two keys collide between the two, the remote source will always override the
+`options` attribute.
 
 ## Similar Projects
 

data/assets/template_aliases.yml

@@ -25,12 +25,12 @@ rr-base:
 rr-ironman:
   git: https://github.com/RootsRated/rootsrated_hyde.git
   subdirectory: ironman
-rr-ironwood:
+rr-graphite:
   git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: ironwood
+  subdirectory: graphite
 rr-new-balance:
   git: https://github.com/RootsRated/rootsrated_hyde.git
   subdirectory: new-balance
-rr-ski-seattle:
+rr-ski:
   git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: ski-seattle
+  subdirectory: ski

data/lib/stevenson/application.rb

@@ -0,0 +1,53 @@
+require 'thor'
+
+module Stevenson
+  class Application < Thor
+    desc 'stevenson new PROJECT_NAME', 'generates a Jekyll at PROJECT_NAME'
+
+    method_option :branch,
+                  aliases: '-b',
+                  desc: 'The git branch you would like to use from your template'
+    method_option :jekyll,
+                  type: :boolean,
+                  aliases: '-j',
+                  desc: 'Jekyll compiles the output directory'
+    method_option :subdirectory,
+                  aliases: '-s',
+                  desc: 'The subdirectory to use from the template, if any'
+    method_option :template,
+                  aliases: '-t',
+                  default: 'hyde-base',
+                  desc: 'The template repository to use'
+    method_option :zip,
+                  type: :boolean,
+                  aliases: "-z",
+                  desc: 'Zip compresses the output directory'
+
+    def new(output_directory)
+      # Load the template using the template loader
+      template = Stevenson::TemplateLoader.load options[:template]
+
+      # If a branch is provided, switch to that branch
+      template.switch_branch options[:branch] if options[:branch]
+
+      # If a subdirectory is provided, switch to that directory
+      template.select_subdirectory options[:subdirectory] if options[:subdirectory]
+
+      # Configure the template
+      configurator = Stevenson::Configurator::YAMLConfigurator.new template.path
+      configurator.configure
+
+      # If the jekyll flag is set, compile the template output
+      template.extend(Stevenson::OutputFilters::JekyllFilter) if options[:jekyll]
+
+      # If the zip flag is set, zip up the template output
+      template.extend(Stevenson::OutputFilters::ZipFilter) if options[:zip]
+
+      # Save the repo to the output directory
+      template.output output_directory
+
+    rescue Templates::InvalidTemplateException => e
+      say e.message
+    end
+  end
+end

data/lib/stevenson/configurators/yaml_configurator.rb

@@ -1,4 +1,3 @@
-require 'highline/import'
 require 'yaml'
 
 module Stevenson
@@ -40,7 +39,7 @@ module Stevenson
       private
 
       def collect_answers(options, config)
-        if !options['question'] || options['question'].is_a?(Hash)
+        if !options['type'] || options['type'].is_a?(Hash)
           # If the current option is not a leaf, iterate over its values
           options.each do |key, value|
             # If no key is present in the config, assign one
@@ -54,9 +53,8 @@ module Stevenson
           # Return the new config
           config
         else
-          # If the option is not a hash, ask the user for input set the key in
-          # the config to it
-          ask_question options, config
+          # Collect the appropriate answer for the given question
+          Input.input_for(options).collect!
         end
       end
 
@@ -76,24 +74,6 @@ module Stevenson
           f.write config.to_yaml
         end
       end
-
-      def ask_question(options, default_value)
-        # Load the question text and highline options hash
-        question = options['question']
-        options.delete 'question'
-  
-        # Ask the user the question and apply all options
-        answer = ask(question) do |q|
-          q.default = default_value if default_value != {}
-          q.echo = false if options['secret']
-          q.validate = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i  if options['email']
-          q.validate = /https?:\/\/[\S]+/  if options['url']
-          q.limit = options['limit'] if options['limit']
-        end
-  
-        # Return the user's answer
-        answer.to_s
-      end
     end
   end
 end

data/lib/stevenson/input/email.rb

@@ -0,0 +1,19 @@
+module Stevenson
+  module Input
+    class Email < Text
+      include Base
+
+      def collect!
+        # Ask the user the question and apply the appropriate options
+        answer = ask(@prompt) do |q|
+          q.default = default
+          q.validate = /\A[\w+\-.]+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z/i
+          q.limit = @limit if @limit
+        end
+
+        # Return the user's answer
+        answer.to_s
+      end
+    end
+  end
+end

data/lib/stevenson/input/password.rb

@@ -0,0 +1,19 @@
+module Stevenson
+  module Input
+    class Password < Text
+      include Base
+
+      def collect!
+        # Ask the user the question and apply the appropriate options
+        answer = ask(@prompt) do |q|
+          q.default = default
+          q.echo = @is_secret
+          q.limit = @limit if @limit
+        end
+
+        # Return the user's answer
+        answer.to_s
+      end
+    end
+  end
+end

data/lib/stevenson/input/select.rb

@@ -0,0 +1,69 @@
+require 'highline/import'
+require 'json'
+require 'net/http'
+
+module Stevenson
+  module Input
+    class Select
+      include Base
+
+      def initialize(options)
+        super
+
+        # Save the basic settings for the prompt
+        @prompt = options['prompt'] || ''
+
+        # Load settings from remote sources, if any
+        load_remote_options options['url'], options if options['url']
+      end
+
+      def collect!
+        # Prompt the user with a menu using the provided settings
+        choose do |menu|
+          menu.prompt = @prompt
+
+          options.each do |key, value|
+            menu.choice(key) { value }
+          end
+        end
+      end
+
+      private
+
+      def load_remote_options(url, options)
+        # Download and parse the JSON to use for options
+        uri = URI(url)
+        raw_json = Net::HTTP.get uri
+        json = JSON.parse raw_json
+
+        # Get the appropriate keys for processing the JSON
+        list_key = options['list_key'] || ''
+        name_key = options['name_key'] || ''
+        value_key = options['value_key'] || options['name_key'] || ''
+
+        # Get the array of items to generate options for
+        list_items = get_value_from_selector json, list_key
+
+        # For each item, fetch the name and value for each option and assign them
+        list_items.each do |list_item|
+          name = get_value_from_selector list_item, name_key
+          value = get_value_from_selector list_item, value_key
+          options[name] = value
+        end
+      end
+
+      def get_value_from_selector(hash, selector_string)
+        # Split the provided selector into an array of selectors
+        selectors = selector_string.split '.'
+
+        # For each one, get the associated subhash from the hash
+        selectors.each do |selector|
+          hash = hash[selector] if hash
+        end
+
+        # Return the resulting hash
+        hash
+      end
+    end
+  end
+end

data/lib/stevenson/input/text.rb

@@ -0,0 +1,28 @@
+require 'highline/import'
+
+module Stevenson
+  module Input
+    class Text
+      include Input::Base
+
+      def initialize(options)
+        super
+
+        # Save the basic settings for the prompt
+        @prompt = options['prompt'] || ''
+        @limit = options['limit'] || false
+      end
+
+      def collect!
+        # Ask the user the question and apply the appropriate options
+        answer = ask(@prompt) do |q|
+          q.default = default
+          q.limit = @limit if @limit
+        end
+
+        # Return the user's answer
+        answer.to_s
+      end
+    end
+  end
+end

data/lib/stevenson/input/url.rb

@@ -0,0 +1,19 @@
+module Stevenson
+  module Input
+    class Url < Text
+      include Base
+
+      def collect!
+        # Ask the user the question and apply the appropriate options
+        answer = ask(@prompt) do |q|
+          q.default = default
+          q.validate = /https?:\/\/[\S]+/
+          q.limit = @limit if @limit
+        end
+
+        # Return the user's answer
+        answer.to_s
+      end
+    end
+  end
+end

data/lib/stevenson/input.rb

@@ -0,0 +1,51 @@
+module Stevenson
+  module Input
+    autoload :Email, 'stevenson/input/email'
+    autoload :Password, 'stevenson/input/password'
+    autoload :Select, 'stevenson/input/select'
+    autoload :Text, 'stevenson/input/text'
+    autoload :Url, 'stevenson/input/url'
+
+    module Base
+      attr_reader :options
+
+      def self.included(input)
+        input.extend ClassMethods
+
+        Stevenson.inputs[input.input_name] = input
+      end
+
+      module ClassMethods
+        def input_name
+          name.gsub(/^.*::/, '').downcase.to_sym
+        end
+      end
+
+      def initialize(options, default=nil)
+        @options, @default = options, default
+      end
+
+      def collect!
+        raise NotImplementedError
+      end
+
+      def default
+        @default ||= options['default'] if options['default']
+        @default ||=  ''
+      end
+    end
+
+    def self.input_for(options)
+      input_klass = input_klass_for(options['type'])
+      input_klass.new(options)
+    end
+
+    private
+
+    def self.input_klass_for(type)
+      Stevenson.inputs[type] || const_get(type.to_s.capitalize)
+    rescue NameError => e
+      raise NameError.new "Type '#{type}' is not a valid input type.", e
+    end
+  end
+end

data/lib/stevenson/version.rb

@@ -1,3 +1,3 @@
 module Stevenson
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/stevenson.rb

@@ -3,57 +3,12 @@ require 'stevenson/output_filters/jekyll'
 require 'stevenson/output_filters/zip'
 require 'stevenson/template_loader'
 require 'stevenson/version'
-require 'thor'
 
 module Stevenson
+  autoload :Application, 'stevenson/application'
+  autoload :Input, 'stevenson/input'
 
-  class Application < Thor
-    desc 'stevenson new PROJECT_NAME', 'generates a Jekyll at PROJECT_NAME'
-
-    method_option :branch,
-                  aliases: '-b',
-                  desc: 'The git branch you would like to use from your template'
-    method_option :jekyll,
-                  type: :boolean,
-                  aliases: '-j',
-                  desc: 'Jekyll compiles the output directory'
-    method_option :subdirectory,
-                  aliases: '-s',
-                  desc: 'The subdirectory to use from the template, if any'
-    method_option :template,
-                  aliases: '-t',
-                  default: 'hyde-base',
-                  desc: 'The template repository to use'
-    method_option :zip,
-                  type: :boolean,
-                  aliases: "-z",
-                  desc: 'Zip compresses the output directory'
-
-    def new(output_directory)
-      # Load the template using the template loader
-      template = Stevenson::TemplateLoader.load options[:template]
-
-      # If a branch is provided, switch to that branch
-      template.switch_branch options[:branch] if options[:branch]
-
-      # If a subdirectory is provided, switch to that directory
-      template.select_subdirectory options[:subdirectory] if options[:subdirectory]
-
-      # Configure the template
-      configurator = Stevenson::Configurator::YAMLConfigurator.new template.path
-      configurator.configure
-
-      # If the jekyll flag is set, compile the template output
-      template.extend(Stevenson::OutputFilters::JekyllFilter) if options[:jekyll]
-
-      # If the zip flag is set, zip up the template output
-      template.extend(Stevenson::OutputFilters::ZipFilter) if options[:zip]
-
-      # Save the repo to the output directory
-      template.output output_directory
-
-    rescue Templates::InvalidTemplateException => e
-      say e.message
-    end
+  def self.inputs
+    @_inputs ||= {}
   end
 end

data/spec/input/email_spec.rb

@@ -0,0 +1,12 @@
+describe Stevenson::Input::Email do
+  describe '#initialize' do
+    let(:text_input) { Stevenson::Input::Email.new({}) }
+
+    it 'creates a new email input' do
+      expect(text_input).to be_an_instance_of Stevenson::Input::Email
+    end
+  end
+
+  describe '#collect!' do
+  end
+end

data/spec/input/password_spec.rb

@@ -0,0 +1,12 @@
+describe Stevenson::Input::Password do
+  describe '#initialize' do
+    let(:text_input) { Stevenson::Input::Password.new({}) }
+
+    it 'creates a new password input' do
+      expect(text_input).to be_an_instance_of Stevenson::Input::Password
+    end
+  end
+
+  describe '#collect!' do
+  end
+end

data/spec/input/select_spec.rb

@@ -0,0 +1,12 @@
+describe Stevenson::Input::Select do
+  describe '#initialize' do
+    let(:text_input) { Stevenson::Input::Select.new({}) }
+
+    it 'creates a new selection input' do
+      expect(text_input).to be_an_instance_of Stevenson::Input::Select
+    end
+  end
+
+  describe '#collect!' do
+  end
+end

data/spec/input/text_spec.rb

@@ -0,0 +1,12 @@
+describe Stevenson::Input::Text do
+  describe '#initialize' do
+    let(:text_input) { Stevenson::Input::Text.new({}) }
+
+    it 'creates a new text input' do
+      expect(text_input).to be_an_instance_of Stevenson::Input::Text
+    end
+  end
+
+  describe '#collect!' do
+  end
+end

data/spec/input/url_spec.rb

@@ -0,0 +1,12 @@
+describe Stevenson::Input::Url do
+  describe '#initialize' do
+    let(:text_input) { Stevenson::Input::Url.new({}) }
+
+    it 'creates a new url input' do
+      expect(text_input).to be_an_instance_of Stevenson::Input::Url
+    end
+  end
+
+  describe '#collect!' do
+  end
+end

data/spec/input_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module Stevenson::Input
+  class Test
+    include Base
+  end
+end
+
+describe Stevenson::Input do
+  let(:input) { double(:test_input) }
+  let(:options) { Hash['type' => :test] }
+  before { allow(Stevenson::Input::Test).to receive(:new).and_return(input) }
+
+  describe ".input_for()" do
+    context "when the input has been registered previously" do
+      it "should return the input class from Stevenson.inputs" do
+        expect(Stevenson::Input.input_for(options)).to eq(input)
+      end
+    end
+
+    context "when the input has not been registered previously" do
+      it "should return the fetched class from Stevenson" do
+        allow(Stevenson).to receive(:inputs).and_return({})
+        expect(Stevenson::Input.input_for(options)).to eq(input)
+      end
+    end
+
+    context "when the input doesn't exist" do
+      it "should raise a NameError with a descriptive error message" do
+        expect { Stevenson::Input.input_for('type' => :bad_input) }.to raise_error do |error|
+          expect(error).to be_a(NameError)
+          expect(error.message).to eq("Type 'bad_input' is not a valid input type.")
+          expect(error.cause).to be_a(NameError)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stevenson
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Dylan Karr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-30 00:00:00.000000000 Z
+date: 2015-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -140,7 +140,14 @@ files:
 - assets/template_aliases.yml
 - bin/stevenson
 - lib/stevenson.rb
+- lib/stevenson/application.rb
 - lib/stevenson/configurators/yaml_configurator.rb
+- lib/stevenson/input.rb
+- lib/stevenson/input/email.rb
+- lib/stevenson/input/password.rb
+- lib/stevenson/input/select.rb
+- lib/stevenson/input/text.rb
+- lib/stevenson/input/url.rb
 - lib/stevenson/output_filters/jekyll.rb
 - lib/stevenson/output_filters/zip.rb
 - lib/stevenson/template_loader.rb
@@ -150,6 +157,12 @@ files:
 - lib/stevenson/version.rb
 - spec/configurators/yaml_configurator_spec.rb
 - spec/helpers.rb
+- spec/input/email_spec.rb
+- spec/input/password_spec.rb
+- spec/input/select_spec.rb
+- spec/input/text_spec.rb
+- spec/input/url_spec.rb
+- spec/input_spec.rb
 - spec/output_filters/jekyll_spec.rb
 - spec/output_filters/zip_spec.rb
 - spec/spec_helper.rb
@@ -177,13 +190,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Stevenson is a generator for Jekyll microsites created by RootsRated.com
 test_files:
 - spec/configurators/yaml_configurator_spec.rb
 - spec/helpers.rb
+- spec/input/email_spec.rb
+- spec/input/password_spec.rb
+- spec/input/select_spec.rb
+- spec/input/text_spec.rb
+- spec/input/url_spec.rb
+- spec/input_spec.rb
 - spec/output_filters/jekyll_spec.rb
 - spec/output_filters/zip_spec.rb
 - spec/spec_helper.rb