cloud_crooner 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0264cd064043ffa30c3b8e1f243c568614c33071
-  data.tar.gz: 5c5c511702a426b686d529d7e3d28b8eb219591c
+  metadata.gz: 96c6f6bcbfc3bc6923aa74ee75f875a9c8be8f37
+  data.tar.gz: df7ffd57e4962c7ad2343b2960c6a553d603301c
 SHA512:
-  metadata.gz: b56c82ae03ac812ba2b39c778ad0f619b62a4115e346d297b7c3b1c63cbfbe01f36d2fb444a14504fed8adc3c980e15e1f717e3a7ec251e087dbb02f2acb8e9c
-  data.tar.gz: 990555fd530e9372fe0efaacdb5a5c3609e990c1148eef286f734c93b59072b6cb13f1df9ac6e00b200af5d13f005705f161e4a7eda3191b4bf7b94f2661fd83
+  metadata.gz: b522ae4cb68eeb23cb34421928954824fdecc6fd7ce894332916403f1492a696110401795d0adae3a4c63a09930e840748f66c98b4568dd91f1d6745db649383
+  data.tar.gz: f7878e04dea4a3349fc84daddb4069dfd3a6c090e7d77de60728d446d49de18add7b9b5ea770d646da28d854532940f42e8933cd2fd0b0d53250317462c6d48b

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# v0.0.2
+* fixed bug where sync did not check for remote_enabled
+
+# v0.0.1
+* initial release

data/README.md

@@ -2,7 +2,7 @@
 
 Manage your Sinatra app's assets with [Sprockets](https://github.com/sstephenson/sprockets) and sync them with [Amazon S3](http://aws.amazon.com/s3/).
 
-Cloud Crooner will run a Sprockets instance and configure helpers for your views. Create a rake task to call the sync method to compile your assets and upload them to the cloud. The helpers will make sure you're pointing to the S3 assets in prod. Your assets will have appended to their names an MD5 hash of their contents which updates when your assets change, ensuring that your users will always be served the freshest assets without needing to worry about expiring caches. 
+Cloud Crooner will run a Sprockets instance and configure helpers for your views. Create a rake task to compile your assets and upload them to the cloud, and use helper methods to make sure you're always pointing to the right asset paths for your environment. In prod, your assets will have appended to their names an MD5 hash of their contents which updates when your assets change, ensuring that your users will always be served the freshest assets without needing to worry about expiring caches. 
 
 ## Installation
 
@@ -20,7 +20,7 @@ Or install it yourself as:
 
 ## Configuration
 
-Cloud Crooner has many configuration options which can be set in a configure block: 
+Cloud Crooner has many configuration options which can be set in a configure block. [Explicit configuration is optional.](#no-configuration)
 
     CloudCrooner.configure do |config|
       config.prefix = '/assets'
@@ -32,7 +32,7 @@ Cloud Crooner has many configuration options which can be set in a configure blo
 
 `prefix` - the path from root where you keep your assets. By default it is `/assets`. Your compiled assets will be placed in `public_folder/prefix.` It will also be the pseudo-folder on S3 where your assets will be stored, so the paths will look something like `http://bucket-name.s3.amazonaws.com/prefix/filename`.
 
-`sprockets` - by default, this will be your Sprockets environment and it will load paths the config option `asset_paths`. 
+`sprockets` - by default, this will be your Sprockets environment and it will add to its load path the paths set in the config option `asset_paths`. 
 
 `asset_paths` - the [load paths](https://github.com/sstephenson/sprockets#the-load-path) for your Sprockets instance. By default it will add the `prefix` directory. 
 
@@ -42,13 +42,16 @@ Cloud Crooner has many configuration options which can be set in a configure blo
 
 `backups_to_keep` - the number of compiled asset backups to keep. Default is 2. When running the sync task, if an asset's content has changed, it will be recompiled. If there are already more than the set number of backups present, the oldest asset will be deleted locally, removed from the manifest, and deleted remotely.
 
-`bucket_name` - the name of your AWS S3 bucket. [See below for details.](#hooking_up )
+### Amazon S3 settings and credentials
+[See "Hooking Up With Your Amazon S3 Account" for details.](#hooking-up-with-your-amazon-s3-account)
 
-`region` - the region of your AWS S3 bucket.  [See below for details.](#hooking_up )
- 
-`aws_access_id_key` - aws credentials. [See below for details.](#hooking_up )
+`bucket_name` - the name of your AWS S3 bucket. 
 
-`aws_secret_access_key` - aws credentials. [See below for details.](#hooking_up )
+`region` - the region of your AWS S3 bucket.  
+
+`aws_access_id_key` - aws credentials. 
+
+`aws_secret_access_key` - aws credentials. 
 
 ### No Configuration
 
@@ -56,9 +59,9 @@ If you're keen to run everything on defaults, you will still need to run one com
 
     CloudCrooner.configure_sprockets_helpers
 
-Normally this is called at the end of the configure method.
+Normally this is called at the end of the `CloudCrooner.configure` method. This method also assumes you have put the S3 settings into ENV outside of the app.
 
-### <a id="hooking_up"></a>Hooking up with your Amazon S3 Account
+### Hooking Up With Your Amazon S3 Account
 
 After you have created an S3 account, [you will will be provided with an "access key id" and a "secret access key"](https://console.aws.amazon.com/iam/home?#security_credential). You will also need your bucket name and the bucket's region. One of the ways to find the region is by going to the [S3 console](https://console.aws.amazon.com/s3/) and checking the end of the URL: it will look something like us-west-1. Cloud Crooner will look for your AWS credentials in your ENV by default. _Do not put your credentials anywhere they can be checked into source control._ I would suggest loading them into the env with your bash login scripts. The env keys that will be checked by default are:
 
@@ -78,7 +81,7 @@ You may also set these in the Cloud Crooner config block, but please do not dire
 
 ## Setting Up Your App:
 
-I have thrown together a very simple application as an example. 
+[I have thrown together a very simple application as an example.](https://github.com/bambery/cloud_crooner_example)
 
 In a file of your choosing (in this case `/config/cloud_crooner_config.rb`) run the configuration block with your desired settings. 
 
@@ -103,6 +106,16 @@ In config.ru, require this file, and set up the following:
       run App # your application class name
     end
 
+You have to register the helpers in your application so they can find your assets:
+
+    class App < Sinatra::Base
+      helpers do
+        include Sprockets::Helpers
+      end
+    end
+
+The helpers which you can use are [detailed below](#helpers). 
+
 To compile and upload the assets, in your rakefile:
 
     require './config/cloud_crooner_config.rb'
@@ -125,6 +138,27 @@ Running your app in development mode will serve uncompiled assets locally (from
 
 If you want to precompile and upload your assets every time you spin up your app, you can put the configure block directly into config.ru and after config run CloudCrooner.sync.
 
+
+## Helpers
+
+Helper methods are provided for use in your views using the [sprockets-helpers](https://github.com/petebrowne/sprockets-helpers) gem.  
+
+`stylesheet_tag` - put this in your views to insert an html tag referencing a stylesheet in the Sprockets load path. For example, if you have `/assets/stylesheets/application.scss` and have placed `assets/stylesheets` in the load path, you would write:
+    <%= stylesheet_tag 'application' %>
+and in dev it will compile to
+    <link rel="stylesheet" href="/assets/application.css">
+in prod it will compile to 
+    <link rel="stylesheet" href="http://my-bucket.s3.amazonaws.com/assets/application.css">
+
+`javascript_tag` - similar to `stylesheet_tag`
+
+`asset_tag` - similar to stylesheet, but you pass a block to generate a tag of your choosing. 
+    asset_tag('main.js') { |path| "<script src=#{path}></script>" }
+will generate
+    <script src=/main.js></script>
+
+`asset_path` - returns the path to an asset, no tag. 
+
 ## Notes About Sass and Sprockets
 
 If you are using sass files, you should use the [ sprockets-sass ](https://github.com/petebrowne/sprockets-sass) and [ sass ](https://github.com/nex3/sass)  gems to help Sprockets cope (sprockets-sass still necessary as of 06/30/13 for functional Sinatra @imports, email me if this changes).

data/lib/cloud_crooner/cloud_crooner.rb

@@ -184,8 +184,10 @@ module CloudCrooner
       compile_sprockets_assets
       clean_sprockets_assets
 
-      storage.upload_files
-      storage.clean_remote
+      if remote_enabled?
+        storage.upload_files
+        storage.clean_remote
+      end
 
     end
 

data/lib/cloud_crooner/version.rb

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

data/spec/cloud_crooner_spec.rb

@@ -292,27 +292,46 @@ describe CloudCrooner do
 
   end # describe
 
-  it 'compiles assets' do
-    within_construct do |c|
-      mock_environment(c)
-      CloudCrooner.assets_to_compile = ['a.css', 'b.css']
-      (CloudCrooner.storage.local_compiled_assets).should == [] 
-      CloudCrooner.compile_sprockets_assets
-
-      expect(CloudCrooner.storage.local_compiled_assets).to eq(['assets/' + CloudCrooner.sprockets['a.css'].digest_path, 'assets/' + CloudCrooner.sprockets['b.css'].digest_path])
-    end # construct
-  end # it
-
-  it 'syncs assets to the cloud', :moo => true do
-    within_construct do |c|
-      mock_environment(c)
-      CloudCrooner.assets_to_compile = ['a.css', 'b.css']
-      mock_fog(CloudCrooner.storage)
-      CloudCrooner.sync
-
-      expect(local_equals_remote?(CloudCrooner.storage)).to be_true
-    end # construct
-  end # it
+  describe 'compiling and syncing assets' do
+
+    it 'compiles assets' do
+      within_construct do |c|
+        mock_environment(c)
+        CloudCrooner.assets_to_compile = ['a.css', 'b.css']
+        (CloudCrooner.storage.local_compiled_assets).should == [] 
+        CloudCrooner.compile_sprockets_assets
+
+        expect(CloudCrooner.storage.local_compiled_assets).to eq(['assets/' + CloudCrooner.sprockets['a.css'].digest_path, 'assets/' + CloudCrooner.sprockets['b.css'].digest_path])
+      end # construct
+    end # it
+
+    it 'compiles and syncs assets to the cloud', :moo => true do
+      within_construct do |c|
+        mock_environment(c)
+        CloudCrooner.assets_to_compile = ['a.css', 'b.css']
+        mock_fog(CloudCrooner.storage)
+        CloudCrooner.sync
+
+        expect(local_equals_remote?(CloudCrooner.storage)).to be_true
+      end # construct
+    end # it
+
+    it 'compiles and does not sync assets if remote_enabled is false' do
+      within_construct do |c|
+        mock_environment(c)
+        CloudCrooner.configure do |config|
+          config.assets_to_compile = ['a.css', 'b.css']
+          config.remote_enabled = false
+        end
+        mock_fog(CloudCrooner.storage)
+        CloudCrooner.sync
+
+        expect(local_equals_remote?(CloudCrooner.storage)).to be_false
+      expect(CloudCrooner.storage.bucket.versions.first).to be_nil
+      end # construct
+    end # it 
+
+  end # describe
 
   after(:each) do
     reload_crooner

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloud_crooner
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - bambery
@@ -132,6 +132,7 @@ files:
 - .gitignore
 - .rspec
 - .rvmrc
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -164,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.5
+rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Manage assets with Sprockets, precompile them into static assets, then upload