frizz 0.0.1 → 0.0.2

data/README.md

@@ -12,19 +12,30 @@ Frizz is a utility for deploying static sites to S3.
 
 Add this line to your application's Gemfile:
 
-    gem "frizz"
+```ruby
+gem "frizz"
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install frizz
+```bash
+$ gem install frizz
+```
 
 ## Usage
 
-### Configure AWS
+### Configuration
+
+#### AWS
+
+Frizz will automatically look for this in ENV vars: `AWS_ACCESS_KEY_ID`
+and `AWS_SECRET_ACCESS_KEY`. Or you can optionally configure manually:
 
 ```ruby
 Frizz.configure do |config|
@@ -33,13 +44,101 @@ Frizz.configure do |config|
 end
 ```
 
-### Setup your site and deploy!
+### Basic deploys
 
 ```ruby
 site = Frizz::Site.new("my-bucket-name.com")
 site.deploy!
 ```
 
+## Usage With Middleman
+
+Managing more than the basic two environments (dev and build) in a Middleman app
+can be a pain, which is why Frizz comes with optional Middleman-specific
+functionality to make things fun again!
+
+### `frizz.yml`
+
+Create a `frizz.yml` in the root of your project. This is how Frizz will know
+what you want in each of your environments and where you want to deploy them
+to.
+
+### Rake tasks
+
+Based on your `frizz.yml`, Frizz will create useful Rake tasks for you.
+
+#### Configuration
+
+Add it to your `Rakefile`:
+
+```ruby
+require "frizz/middleman/tasks"
+```
+
+#### Usage
+
+With the following `frizz.yml`:
+
+```yaml
+environments:
+  staging:
+    bucket: "staging.example.com"
+  production:
+    bucket: "example.com"
+```
+
+Frizz would give us the following Rake tasks:
+
+```bash
+$ rake -T
+rake frizz:build:production   # Build production
+rake frizz:build:staging      # Build staging
+rake frizz:deploy:production  # Build and deploy production
+rake frizz:deploy:staging     # Build and deploy staging
+```
+
+### Settings and Variables for each of your environments
+
+Ever built a frontend app and wanted to hit a different API for dev, staging,
+and production environments? Frizz lets you specify arbitrary environment-specific
+configurations in `frizz.yml` and access them later in your Middleman app's views.
+
+#### Configuration
+
+Add it to your `config.rb`:
+
+```ruby
+require "frizz/middleman/view_helpers"
+helpers Frizz::Middleman::ViewHelpers
+```
+
+#### Usage
+
+With the following `frizz.yml`:
+
+```yaml
+environments:
+  staging:
+    bucket: "staging.example.com"
+    api_root: http://api.staging.example.com/v0
+    welcome_message: I'm A Staging Server
+  production:
+    bucket: "example.com"
+    api_root: http://api.example.com/v0
+    welcome_message: I'm A Production Server
+  development:
+    api_root: http://localhost:3000/v0
+    welcome_message: Developers! Developers! Developers!
+```
+
+You would be able to access your variables from views like so:
+
+```html
+<script type="text/javascript">MyApp.config.apiRoot = "<%= frizz.api_root %>";</script>
+<h1><%= frizz.welcome_message %></h1>
+<h2><%= "And hi QA team!" if frizz.staging? %></h2>
+```
+
 ## Contributing
 
 1. Fork it

data/lib/frizz/configuration.rb

@@ -0,0 +1,40 @@
+module Frizz
+  class Configuration
+    YAML_FILENAME = "frizz.yml"
+
+    attr_accessor :access_key_id, :secret_access_key, :environments,
+      :current_environment
+
+    def initialize
+      self.environments = {}
+
+      # Attempt to load defaults from ENV
+      self.access_key_id = ENV["AWS_ACCESS_KEY_ID"]
+      self.secret_access_key = ENV["AWS_SECRET_ACCESS_KEY"]
+      self.current_environment = ENV["FRIZZ_ENV"] || "development"
+
+      # Allow to be overridden in yaml
+      load_yaml!
+    end
+
+    def environment
+      environments[current_environment]
+    end
+
+    def environments=(environments_data)
+      @environments = environments_data.each_with_object({}) do |(name, data), obj|
+        obj[name] = Environment.new(name, data)
+      end
+    end
+
+    private
+
+    def load_yaml!
+      return unless File.exists?(YAML_FILENAME)
+
+      YAML.load_file(YAML_FILENAME).each do |key, value|
+        send "#{key}=", value
+      end
+    end
+  end
+end

data/lib/frizz/environment.rb

@@ -0,0 +1,24 @@
+module Frizz
+  class Environment
+    attr_reader :name
+
+    def initialize(name, data)
+      @name = name
+
+      data.each do |attribute, value|
+        ivar_name = "@#{attribute}"
+        instance_variable_set(ivar_name, value)
+
+        self.class.send :define_method, attribute do
+          instance_variable_get(ivar_name)
+        end
+      end
+    end
+
+    # This is a creative way to allow for calling frizz.production? or
+    # frizz.staging? from the Middleman view helpers
+    def method_missing(meth, args, &block)
+      name == meth.to_s
+    end
+  end
+end

data/lib/frizz/middleman/tasks.rb

@@ -0,0 +1,53 @@
+require "frizz"
+
+module Frizz
+  module Middleman
+    module CmdHelper
+      def self.run_with_live_output(cmd)
+        IO.popen(cmd) do |io|
+          io.each do |line|
+            puts line
+          end
+        end
+      end
+    end
+
+    class Tasks
+      include Rake::DSL
+
+      def self.install!
+        new.install
+      end
+
+      def install
+        namespace :frizz do
+          namespace :build do
+            relevant_environments.each do |name, env|
+              desc "Build #{env.name}"
+              task env.name do
+                CmdHelper.run_with_live_output "FRIZZ_ENV=#{env.name} middleman build"
+              end
+            end
+          end
+
+          namespace :deploy do
+            relevant_environments.each do |name, env|
+              desc "Build and deploy #{env.name}"
+              task env.name => ["frizz:build:#{env.name}"] do
+                Frizz::Site.new(env.bucket).deploy!
+              end
+            end
+          end
+        end
+      end
+
+      private
+
+      def relevant_environments
+        Frizz.configuration.environments.reject { |name, env| name == "development" }
+      end
+    end
+  end
+end
+
+Frizz::Middleman::Tasks.install!

data/lib/frizz/middleman/view_helpers.rb

@@ -0,0 +1,9 @@
+module Frizz
+  module Middleman
+    module ViewHelpers
+      def frizz
+        Frizz.configuration.environment
+      end
+    end
+  end
+end

data/lib/frizz/version.rb

@@ -1,3 +1,3 @@
 module Frizz
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/frizz.rb

@@ -6,8 +6,8 @@ module Frizz
   autoload :Local, "frizz/local"
   autoload :Remote, "frizz/remote"
   autoload :Sync, "frizz/sync"
-
-  Configuration = Struct.new(:access_key_id, :secret_access_key)
+  autoload :Configuration, "frizz/configuration"
+  autoload :Environment, "frizz/environment"
 
   class << self
     def configure

metadata

@@ -2,14 +2,14 @@
 name: frizz
 version: !ruby/object:Gem::Version
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - patbenatar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   prerelease: false
@@ -105,7 +105,11 @@ files:
 - Rakefile
 - frizz.gemspec
 - lib/frizz.rb
+- lib/frizz/configuration.rb
+- lib/frizz/environment.rb
 - lib/frizz/local.rb
+- lib/frizz/middleman/tasks.rb
+- lib/frizz/middleman/view_helpers.rb
 - lib/frizz/remote.rb
 - lib/frizz/site.rb
 - lib/frizz/sync.rb
@@ -123,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -3366162893133711877
+      hash: 2336966259519313102
       version: '0'
   none: false
 required_rubygems_version: !ruby/object:Gem::Requirement
@@ -132,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       segments:
       - 0
-      hash: -3366162893133711877
+      hash: 2336966259519313102
       version: '0'
   none: false
 requirements: []