stevenson 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d4bbb1c5387f8971d634dbab92d275947b481e6a
-  data.tar.gz: 8944fee22ba3f747259246c6512c9b13860a6b2f
+  metadata.gz: 65c934219c82cb57f9ed0cb87eda58348cc6219d
+  data.tar.gz: ffc0f55365499f06312e1ae956f5f6847eb25072
 SHA512:
-  metadata.gz: a06819996cd37937b72e2d6e000336a867af6723402b41e353654c913a739b8cc9f87bad2e25a27cdb0d051e65e2593cbd87f1d14c38251d8d7c37f3b7734029
-  data.tar.gz: a91025832a88cf33489e40a6360c6ee78c6c1f91b70f392f88564966b6e9ad1fd6491df3ece4827b555a5257e6ad80b6a4b13384b7ff859d3b127008088300c4
+  metadata.gz: 6adb7a7c86cc0f9616e9d44568180a3017eb3c31899e10ddeccaccf8699bcb372793c24197bb2b37425279ce34f88557776cdd03ff2204b168d5fab0b8559555
+  data.tar.gz: bf375e0bc19e27e9b26151d3573dbb4ad786aea0ae4bded4c906d624eedd207b76ede31bd9a315583d18d828ab0224f31385b5f2ce7725980358cf3c6e23241f

data/.travis.yml

@@ -3,3 +3,6 @@ cache: bundler
 sudo: false
 rvm:
   - 2.1.2
+addons:
+  code_climate:
+    repo_token: 501db1ee30adeb1d36c5ad36fc6db62a75f7fdd43d4df3da1e55a8be7e76e179

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+2.1.0 (October 3rd, 2015)
+ - Add deployer logic
+ - Add S3 deployer class for sending compiled projects to S3 buckets
+
+2.0.0 (September 30th, 2015)
+ - Add template aliases as dotfile
+ - Remove individual template config logic and inputs
+ - Refactor processing logic from templates, with data files, and through output filters

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in stevenson.gemspec
 gemspec
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/README.md

@@ -1,5 +1,8 @@
 # Stevenson
 [![Build Status](https://travis-ci.org/RootsRated/stevenson.png)](https://travis-ci.org/RootsRated/stevenson)
+[![Gem Version](https://badge.fury.io/rb/stevenson.svg)](http://badge.fury.io/rb/stevenson)
+[![Code Climate](https://codeclimate.com/github/RootsRated/stevenson/badges/gpa.svg)](https://codeclimate.com/github/RootsRated/stevenson)
+[![Test Coverage](https://codeclimate.com/github/RootsRated/stevenson/badges/coverage.svg)](https://codeclimate.com/github/RootsRated/stevenson/coverage)
 
 Stevenson is a [Jekyll](http://jekyllrb.com) microsite generator created by
 RootsRated.com. Stevenson is named for Robert Louis Stevenson, author of *The
@@ -35,35 +38,6 @@ This will create a new directory in your current working directory named
 `hello_world`. This directory should be a ready-to-use Jekyll
 installation.
 
-### Jekyll Compiling
-
-Stevenson can automatically jekyll build a project and output a built directory
-using the `-j` or `--jekyll`. Following the example from above, you can use the
-following command:
-
-    $ stevenson new hello_world -j
-
-This will output a directory called `hello_world` with the built assets from the
-jekyll project created by the earlier command without the jekyll flag.
-
-### Zip Output
-
-Stevenson can also output directories as a zip archive using the `-z` or `--zip`
-flags. The following command will produce the same result as the first example
-as a zip archive:
-
-    $ stevenson new hello_world.zip -z
-
-Also, the zip flag and jekyll flag can be used together to produce a built and
-compress out like so:
-
-    $ stevenson new hello_world.zip -z -j
-
-This will output a file called `hello_world.zip` with a ready-built website.
-
-Remember that the first argument to `stevenson new` should have a `.zip` on the
-end, as stevenson will not automatically add this extension.
-
 ### Templates
 
 By default, stevenson will use RootsRated's
@@ -74,138 +48,27 @@ option, like so:
     $ stevenson new hello_world -t https://github.com/YourUsername/YourTemplate.git
 
 This will clone the repo at `https://github.com/YourUsername/YourTemplate.git`
-to `hello_world` and begin altering the repo based on the contents of a
-YAML file in your template's root directory named `_stevenson.yml`. This file
-should contain config options to be set in various files of your Jekyll
-installation along with information on whether these options should be secret,
-validated as emails, validated as URLs, or limited to a certain length.
-
-Here's an example of the YAML file:
-
-    # _stevenson.yml
-
-    '_config.yml':
-      title:
-        type: 'text'
-        prompt: 'Title: '
-        limit: 40
-      email:
-        type: 'email'
-        prompt: 'Email: '
-      description:
-        type: 'text'
-        prompt: 'Description: '
-      url:
-        type: 'url'
-        prompt: 'URL: '
-
-This file will produce the following questions when
-`stevenson new hello_world https://github.com/YourUsername/YourTemplate.git` is
-used:
-
-    $ stevenson new hello_world -t https://github.com/YourUsername/YourTemplate.git
-    Title: My Site
-    Email: info@example.org
-    Description: Lorem Ipsum...
-    URL: http://www.example.org
-
-When these questions are answered, the following will be added to
-`hello_world/_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
+to `hello_world`.
 
-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'
+### Zip Output
 
-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`.
+Stevenson can output directories as a zip archive using the `-z` or `--zip`
+flags. The following command will produce a zipped version of the first
+example's result:
 
-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:
+    $ stevenson new hello_world.zip -z
 
-    # http://someapi.com/source.json
+This will output a file called `hello_world.zip` with a ready-built website.
 
-    {
-      "response": [
-        {
-            "name": "Red",
-            "value": "#FF0000"
-        },
-        {
-            "name": "Blue",
-            "value": "#00FF00"
-        },
-        {
-            "name": "Green",
-            "value": "#0000FF"
-        }
-      ]
-    }
+### S3 Deploy
 
-    # _stevenson.yml
+Stevenson can deploy projects to S3 using the `--s3` flag. The following
+command will deploy the resulting output to S3:
 
-    favorite_color:
-      type: 'select'
-      prompt: 'Favorite Color: '
-      url: 'http://someapi.com/source.json'
-      list_key: 'response'
-      name_key: 'name'
-      value_key: 'value'
+    $ stevenson new hello_world.zip --s3=bucket file_key AWS_KEY AWS_SECRET
 
-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.
+Additionally, Stevenson can use the `AWS_ACCESS_KEY_ID` and
+`AWS_SECRET_ACCESS_KEY` environment variables.
 
 ## Similar Projects
 
@@ -228,3 +91,10 @@ idea a while back, but unfortunately it hasn't been updated in over 2 years.
 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
+
+### Contributors
+
+- [Dylan Karr](https://github.com/dylankarr)
+- [Scott BonAmi](http://github.com/sbonami)
+
+Don't forget to check out other open-source projects from [RootsRated](http://github.com/RootsRated)!

data/lib/stevenson/application.rb

@@ -22,9 +22,10 @@ module Stevenson
                   aliases: "-d",
                   desc: 'The path to related data yml files'
 
-    # Output Options
+    # Output Filter Options
     method_option :output,
                   type: :array,
+                  enum: [:zip],
                   aliases: "-o",
                   desc: 'Array of output filters to be applied in order'
     method_option :zip,
@@ -32,6 +33,12 @@ module Stevenson
                   aliases: "-z",
                   desc: 'Zip compresses the output directory'
 
+    # Deploy Options
+    method_option :s3,
+                  type: :array,
+                  banner: 'bucket key access_key access_secret',
+                  desc: 'The s3 information necessary for deploying to S3'
+
     def new(output_directory, config_path)
       # Load the template using the template loader
       template = Stevenson::Template.load(options[:template], options)
@@ -41,7 +48,10 @@ module Stevenson
       template.place_files(options[:data], '_data') if options[:data]
 
       # Run output filters, in order, against the template
-      puts Stevenson::OutputFilter.generate!(template, options)
+      directory = Stevenson::OutputFilter.generate!(template, options)
+
+      # Run deployers against filtered template directory
+      Stevenson::Deployer.deploy(directory, options)
 
     rescue StandardError => e
       say e.message

data/lib/stevenson/deployer.rb

@@ -0,0 +1,53 @@
+module Stevenson
+  module Deployer
+    autoload :S3, 'stevenson/deployers/s3'
+
+    module Base
+      attr_reader :options
+
+      def self.included(deployer)
+        deployer.extend ClassMethods
+
+        Stevenson.deployers[deployer.deployer_name] = deployer
+      end
+
+      module ClassMethods
+        def deployer_name
+          name.gsub(/^.*::/, '').downcase.to_sym
+        end
+      end
+
+      def initialize(options)
+        @options = options
+      end
+
+      def deploy!(directory)
+        raise NotImplementedError
+      end
+    end
+
+    class << self
+      def deploy(directory, options)
+        deployers_for(options).each do |deployer|
+          deployer.new(options).deploy!(directory)
+        end
+      end
+
+      private
+
+      def deployers_for(options)
+        [].tap do |deployers|
+          deployers << deployer_for(:s3) if options.keys.include?("s3")
+        end
+      end
+
+      def deployer_for(type)
+        Stevenson.deployers.fetch(type, nil) || const_get(type.to_s.capitalize)
+      rescue NameError
+        raise InvalidDeployerException.new "Type '#{type}' is not a valid deployer."
+      end
+    end
+
+    class InvalidDeployerException < StandardError; end
+  end
+end

data/lib/stevenson/deployers/s3.rb

@@ -0,0 +1,40 @@
+require 'fog'
+
+module Stevenson
+  module Deployer
+    class S3
+      include Deployer::Base
+
+      attr_reader :deployment_bucket_name, :deployment_key
+
+      def initialize(options)
+        @deployment_bucket_name, @deployment_key, @deployment_access_key, @deployment_access_secret = options["s3"]
+        super
+      end
+
+      def deploy!(directory)
+        Dir.glob("#{directory}/**/*").each do |file|
+          s3_bucket.files.create(
+            key:    File.join(deployment_key, file.partition(directory).last),
+            body:   File.read(file),
+            public: true,
+          ) if File.file?(file)
+        end
+      end
+
+      private
+
+      def fog
+        @_fog ||= Fog::Storage.new(
+          provider:              'AWS',
+          aws_access_key_id:     @deployment_access_key || ENV["AWS_ACCESS_KEY_ID"],
+          aws_secret_access_key: @deployment_access_secret || ENV["AWS_SECRET_ACCESS_KEY"],
+        )
+      end
+
+      def s3_bucket
+        @_s3_bucket = fog.directories.new(key: deployment_bucket_name)
+      end
+    end
+  end
+end

data/lib/stevenson/template.rb

@@ -17,7 +17,7 @@ module Stevenson
       end
 
       def place_config(config_file)
-        place_files(config_file, 'config.yml')
+        place_files(config_file, '_config.yml')
       end
 
       def place_files(files, directory)

data/lib/stevenson/version.rb

@@ -1,3 +1,3 @@
 module Stevenson
-  VERSION = "2.0.0"
+  VERSION = "2.1.0"
 end

data/lib/stevenson.rb

@@ -2,10 +2,15 @@ require 'stevenson/version'
 
 module Stevenson
   autoload :Application, 'stevenson/application'
+  autoload :Deployer, 'stevenson/deployer'
   autoload :Dotfile, 'stevenson/dotfile'
   autoload :Template, 'stevenson/template'
   autoload :OutputFilter, 'stevenson/output_filter'
 
+  def self.deployers
+    @_deployers ||= {}
+  end
+
   def self.dotfile
     @_dotfile ||= Dotfile.new
   end

data/spec/lib/deployer_spec.rb

@@ -0,0 +1,38 @@
+class Stevenson::Deployer::Test
+  include Stevenson::Deployer::Base
+end
+
+describe Stevenson::Deployer do
+  let(:deployer) { Stevenson::Deployer::Test }
+
+  describe ".deploy(directory, options)" do
+    let(:directory) { "/tmp/path/to/template" }
+    let(:options) { Hash.new }
+    let(:deployer) { double(:deployer, deploy!: true) }
+    subject { described_class.generate!(template, options) }
+  end
+
+  describe ".deployer_for()" do
+    context "when the deployer has been registered previously" do
+      it "should return the deployer class from Stevenson.deployers" do
+        expect(Stevenson::Deployer.send(:deployer_for, :test)).to eq(deployer)
+      end
+    end
+
+    context "when the deployer has not been registered previously" do
+      it "should return the deployer class from Stevenson.deployers" do
+        allow(Stevenson).to receive(:deployers).and_return({})
+        expect(Stevenson::Deployer.send(:deployer_for, :test)).to eq(deployer)
+      end
+    end
+
+    context "when the deployer doesn't exist" do
+      it "should raise a NameError with a descriptive error message" do
+        expect { Stevenson::Deployer.send(:deployer_for, :bad_deployer) }.to raise_error do |error|
+          expect(error).to be_a(Stevenson::Deployer::InvalidDeployerException)
+          expect(error.message).to eq("Type 'bad_deployer' is not a valid deployer.")
+        end
+      end
+    end
+  end
+end

data/spec/lib/deployers/s3_spec.rb

@@ -0,0 +1,3 @@
+describe Stevenson::Deployer::S3 do
+
+end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'bundler/setup'
 Bundler.setup
 
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
 require 'helpers'
 require 'stevenson'
 

data/stevenson.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
 
   spec.add_dependency "git"
+  spec.add_dependency "fog"
   spec.add_dependency "hashie"
   spec.add_dependency "highline"
   spec.add_dependency "jekyll"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stevenson
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - RootsRated
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-30 00:00:00.000000000 Z
+date: 2015-10-03 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: fog
+  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: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +161,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -155,6 +170,8 @@ files:
 - bin/stevenson
 - lib/stevenson.rb
 - lib/stevenson/application.rb
+- lib/stevenson/deployer.rb
+- lib/stevenson/deployers/s3.rb
 - lib/stevenson/dotfile.rb
 - lib/stevenson/output_filter.rb
 - lib/stevenson/output_filter/generator.rb
@@ -167,6 +184,8 @@ files:
 - lib/stevenson/version.rb
 - spec/bin/.gitkeep
 - spec/helpers.rb
+- spec/lib/deployer_spec.rb
+- spec/lib/deployers/s3_spec.rb
 - spec/lib/output_filter/generator_spec.rb
 - spec/lib/output_filter_spec.rb
 - spec/lib/output_filters/jekyll_spec.rb
@@ -204,6 +223,8 @@ summary: Stevenson is a generator for Jekyll microsites created by RootsRated.co
 test_files:
 - spec/bin/.gitkeep
 - spec/helpers.rb
+- spec/lib/deployer_spec.rb
+- spec/lib/deployers/s3_spec.rb
 - spec/lib/output_filter/generator_spec.rb
 - spec/lib/output_filter_spec.rb
 - spec/lib/output_filters/jekyll_spec.rb