stevenson 1.0.1 → 2.0.0

data/spec/lib/template_spec.rb

@@ -0,0 +1,20 @@
+describe Stevenson::Template do
+  let(:template_name) { 'template' }
+  let(:options) { Hash.new }
+
+  describe ".load(template, options)" do
+    let(:template) { double(:template) }
+    let(:loader) { double(:loader, template: template) }
+    subject { described_class.load(template_name, options) }
+
+    it "should call Loader.new with template_name and options" do
+      expect(Stevenson::Template::Loader).to receive(:new).with(template_name, options).and_return(loader)
+      subject
+    end
+
+    it "should return Loader's template response" do
+      allow(Stevenson::Template::Loader).to receive(:new).and_return(loader)
+      expect(subject).to eq template
+    end
+  end
+end

data/spec/lib/templates/git_spec.rb

@@ -0,0 +1,43 @@
+describe Stevenson::Template::Git do
+  let(:template_url) { 'http://www.github.com/Org/repo.git' }
+  let(:options) { Hash.new }
+  subject { described_class.new(template_url, options) }
+
+  describe '#local_directory' do
+    let(:tmp_dir) { '/tmp/dir/to/template' }
+    before { allow(Dir).to receive(:mktmpdir).and_return(tmp_dir) }
+
+    context 'when template_url is a valid URL' do
+      let(:git_repo) { double(:git_repo) }
+      before { allow(::Git).to receive(:clone).and_return(git_repo) }
+
+      it 'returns a temp directory' do
+        expect(subject.local_directory).to eq tmp_dir
+      end
+
+      it 'clones the given repository to the working template path' do
+        expect(::Git).to receive(:clone).with(template_url, tmp_dir)
+        subject.local_directory
+      end
+
+      context "when the :branch option is set" do
+        let(:branch) { 'test-branch' }
+        let(:options) { { branch: branch } }
+
+        it "should check out the related branch" do
+          expect(git_repo).to receive(:checkout).with(branch).and_return(true)
+          subject.local_directory
+        end
+      end
+    end
+
+    context 'when template_url is an invalid URL' do
+      let(:template_url) {  'not/a/repo' }
+      before { allow(::Git).to receive(:clone).and_raise(::Git::GitExecuteError) }
+
+      it 'raises an invalid template exception' do
+        expect { subject.local_directory }.to raise_exception(Stevenson::Template::InvalidTemplateException)
+      end
+    end
+  end
+end

data/spec/lib/templates/local_spec.rb

@@ -0,0 +1,42 @@
+describe Stevenson::Template::Local do
+  let(:template_path) { '/path/to/local/template' }
+  let(:options) { Hash.new }
+  subject { described_class.new(template_path, options) }
+
+  describe '#local_directory' do
+    let(:tmp_dir) { '/tmp/dir/to/template' }
+    before { allow(Dir).to receive(:mktmpdir).and_return(tmp_dir) }
+
+    context 'when template_path is a valid path' do
+      before { allow(File).to receive(:directory?).and_return(true) }
+
+      it 'returns a temp directory' do
+        allow(FileUtils).to receive(:cp_r).and_return(true)
+        expect(subject.local_directory).to eq tmp_dir
+      end
+
+      it "copies the template_path's contents to the temp directory" do
+        expect(FileUtils).to receive(:cp_r).with("#{template_path}/.", tmp_dir).and_return(true)
+        expect(subject.local_directory).to eq tmp_dir
+      end
+
+      context "when the :subdirectory option is set" do
+        let(:subdirectory) { 'subdirectory' }
+        let(:options) { { subdirectory: subdirectory } }
+
+        it "should copy the template_path's subdirectory" do
+          expect(FileUtils).to receive(:cp_r).with("#{template_path}/#{subdirectory}/.", tmp_dir).and_return(true)
+          subject.local_directory
+        end
+      end
+    end
+
+    context 'when template_path is an invalid path' do
+      before { allow(File).to receive(:directory?).and_return(false) }
+
+      it 'raises an invalid template exception' do
+        expect { subject.local_directory }.to raise_exception(Stevenson::Template::InvalidTemplateException)
+      end
+    end
+  end
+end

data/stevenson.gemspec

@@ -6,8 +6,8 @@ require 'stevenson/version'
 Gem::Specification.new do |spec|
   spec.name          = "stevenson"
   spec.version       = Stevenson::VERSION
-  spec.authors       = ["Dylan Karr"]
-  spec.email         = ["dylan@RootsRated.com"]
+  spec.authors       = ["RootsRated"]
+  spec.email         = ["developers@rootsrated.com"]
   spec.summary       = "Stevenson is a generator for Jekyll microsites created by RootsRated.com"
   spec.description   = "Stevenson is a simple generator for microsites using Jekyll"
   spec.homepage      = ""
@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
 
   spec.add_dependency "git"
+  spec.add_dependency "hashie"
   spec.add_dependency "highline"
   spec.add_dependency "jekyll"
   spec.add_dependency "rubyzip", ">= 1.0.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stevenson
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 2.0.0
 platform: ruby
 authors:
-- Dylan Karr
+- RootsRated
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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
   name: highline
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +138,7 @@ dependencies:
         version: '0'
 description: Stevenson is a simple generator for microsites using Jekyll
 email:
-- dylan@RootsRated.com
+- developers@rootsrated.com
 executables:
 - stevenson
 extensions: []
@@ -137,38 +151,31 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- assets/template_aliases.yml
+- assets/stevenson_dotfile.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/dotfile.rb
+- lib/stevenson/output_filter.rb
+- lib/stevenson/output_filter/generator.rb
 - lib/stevenson/output_filters/jekyll.rb
 - lib/stevenson/output_filters/zip.rb
-- lib/stevenson/template_loader.rb
-- lib/stevenson/templates/base.rb
+- lib/stevenson/template.rb
+- lib/stevenson/template/loader.rb
 - lib/stevenson/templates/git.rb
-- lib/stevenson/templates/invalid_template_exception.rb
+- lib/stevenson/templates/local.rb
 - lib/stevenson/version.rb
-- spec/configurators/yaml_configurator_spec.rb
+- spec/bin/.gitkeep
 - 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/lib/output_filter/generator_spec.rb
+- spec/lib/output_filter_spec.rb
+- spec/lib/output_filters/jekyll_spec.rb
+- spec/lib/output_filters/zip_spec.rb
+- spec/lib/template/loader_spec.rb
+- spec/lib/template_spec.rb
+- spec/lib/templates/git_spec.rb
+- spec/lib/templates/local_spec.rb
 - spec/spec_helper.rb
-- spec/template_loader_spec.rb
-- spec/templates/base_spec.rb
-- spec/templates/git_spec.rb
 - stevenson.gemspec
 homepage: ''
 licenses:
@@ -190,22 +197,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.3
 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/bin/.gitkeep
 - 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/lib/output_filter/generator_spec.rb
+- spec/lib/output_filter_spec.rb
+- spec/lib/output_filters/jekyll_spec.rb
+- spec/lib/output_filters/zip_spec.rb
+- spec/lib/template/loader_spec.rb
+- spec/lib/template_spec.rb
+- spec/lib/templates/git_spec.rb
+- spec/lib/templates/local_spec.rb
 - spec/spec_helper.rb
-- spec/template_loader_spec.rb
-- spec/templates/base_spec.rb
-- spec/templates/git_spec.rb

data/assets/template_aliases.yml

@@ -1,36 +0,0 @@
-hyde-base:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: base
-templatedco-exmachina:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: exmachina
-templatedco-horizons:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: horizons
-templatedco-ion:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: ion
-templatedco-linear:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: linear
-templatedco-phaseshift:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: phaseshift
-templatedco-solarize:
-  git: https://github.com/RootsRated/hyde.git
-  subdirectory: solarize
-rr-base:
-  git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: base
-rr-ironman:
-  git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: ironman
-rr-graphite:
-  git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: graphite
-rr-new-balance:
-  git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: new-balance
-rr-ski:
-  git: https://github.com/RootsRated/rootsrated_hyde.git
-  subdirectory: ski

data/lib/stevenson/configurators/yaml_configurator.rb

@@ -1,79 +0,0 @@
-require 'yaml'
-
-module Stevenson
-  module Configurator
-    class YAMLConfigurator
-      def initialize(config_path)
-        # Save the config path for later use
-        @config_path = config_path
-
-        # Load options from the template
-        @root_options = load_yaml File.join(config_path, '_stevenson.yml')
-      end
-
-      def configure(path=nil, options=nil)
-        # If no options are provided, use the root_options
-        options ||= @root_options
-
-        # If no path is provided, use the config_path
-        path ||= @config_path
-
-        # If the path is a directory, recursively configure that directory
-        if File.directory? path
-          # Iterate through each option provided
-          options.each do |key, value|
-            configure "#{path}/#{key}", value
-          end
-        else
-          # If path is a file, load the YAML from that file
-          config = load_yaml path
-
-          # Collect answers for the config in the file
-          config = collect_answers options, config
-
-          # And save the config back to YAML file.
-          save_yaml path, config
-        end
-      end
-
-      private
-
-      def collect_answers(options, config)
-        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
-            config[key] = {} unless config[key]
-
-            # Recursively collect answers for the current key in the config and
-            # options
-            config[key] = collect_answers value, config[key]
-          end
-
-          # Return the new config
-          config
-        else
-          # Collect the appropriate answer for the given question
-          Input.input_for(options).collect!
-        end
-      end
-
-      def load_yaml(path)
-        # If a YAML file is present, load it
-        if File.file? path
-          YAML.load_file(path) || {}
-        else
-          # Otherwise, return an empty hash
-          {}
-        end
-      end
-
-      def save_yaml(path, config)
-        # Write config to path as YAML
-        File.open(path, 'w') do |f|
-          f.write config.to_yaml
-        end
-      end
-    end
-  end
-end

data/lib/stevenson/input/email.rb

@@ -1,19 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,69 +0,0 @@
-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

@@ -1,28 +0,0 @@
-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

@@ -1,19 +0,0 @@
-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

@@ -1,51 +0,0 @@
-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/template_loader.rb

@@ -1,50 +0,0 @@
-require 'stevenson/templates/base'
-require 'stevenson/templates/git'
-require 'yaml'
-
-module Stevenson
-  class TemplateLoader
-    TEMPLATE_ALIASES_PATH = File.join('..', '..', 'assets', 'template_aliases.yml')
-
-    def self.load(template_name)
-      # If a template alias exists with the key template
-      if template_aliases[template_name]
-        # Load a template and return it
-        load_template template_aliases[template_name]
-      elsif template_name =~ /^.*\.git$/
-        # If the given string is a git url, load the git template and return it
-        Templates::GitTemplate.new template_name
-      else
-        # Otherwise, return a new template using the name as a path
-        Templates::Base.new template_name
-      end
-    end
-
-    def self.template_aliases
-      # Get the path to the template aliases file
-      template_aliases_path = File.join(File.dirname(__FILE__), TEMPLATE_ALIASES_PATH)
-
-      # Load the template aliases
-      template_aliases = YAML.load_file template_aliases_path
-    end
-
-    def self.load_template(template_options)
-      # If the template options contain a git url, load the git template and return it
-      if template_options['git']
-        template = Templates::GitTemplate.new template_options['git']
-
-        # If the alias provides a branch, switch to it
-        template.switch_branch template_options['branch'] if template_options['branch']
-
-        # If the alias provides a subdirectory, switch to it
-        template.select_subdirectory template_options['subdirectory'] if template_options['subdirectory']
-
-        # Return the template
-        template
-      else
-        # Otherwise, return false
-        false
-      end
-    end
-  end
-end

data/lib/stevenson/templates/base.rb

@@ -1,45 +0,0 @@
-require 'stevenson/templates/invalid_template_exception'
-
-module Stevenson
-  module Templates
-    class Base
-      def initialize(path)
-        if !File.directory?(path)
-          # If the given path is not a directory, raise an invalid template exception
-          raise InvalidTemplateException.new('The given path is not a directory')
-        else
-          # Otherwise, copy the template to a temporary directory to work with
-          @path = Dir.mktmpdir
-          FileUtils.cp_r File.join(path, '.'), @path
-        end
-      end
-  
-      def path
-        # Return the path to the repo
-        @path
-      end
-
-      def select_subdirectory(directory)
-        # Create a new temporary directory to work from
-        new_path = Dir.mktmpdir
-
-        # Copy files from the subdirectory to the new temp dir
-        FileUtils.cp_r File.join(@path, directory, '.'), new_path
-
-        # Remove the old temporary directory
-        FileUtils.remove_entry_secure @path
-
-        # Set the path to the new path
-        @path = new_path
-      end
-  
-      def output(directory)
-        # Copy the configured template to the output_directory
-        FileUtils.copy_entry @path, directory
-  
-        # Cleanup the temporary directory
-        FileUtils.remove_entry_secure @path
-      end
-    end
-  end
-end