jekyll-s3 2.2.2 → 2.2.3

data/README.md

@@ -9,7 +9,7 @@ Deploy your jekyll site to S3.
 
 * Upload your site to AWS S3
 * Help you use AWS Cloudfront to distribute your Jekyll blog
-* Create the S3 bucket for you
+* Create an S3 website for you
 
 ## Install
 
@@ -73,11 +73,31 @@ _jekyll_s3.yml`. This creates you a bucket in the US Standard region.
 
 ## Development
 
+### Versioning
+
+Jekyll-s3 uses [Semantic Versioning](http://semver.org).
+
+### Tests
+
   * Install bundler and run `bundle install`
   * Run all tests by invoking `rake test`
   * Run the integration tests by running `bundle exec cucumber`
   * Run the unit tests by running `bundle exec rspec spec/lib/*.rb`
 
+### Contributing
+
+We (users and developers of Jekyll-s3) welcome patches, pull requests and
+ideas for improvement.
+
+When sending pull requests, please accompany them with tests. Favor BDD style
+in test descriptions. Use VCR-backed integration tests where possible. For
+reference, you can look at the existing Jekyll-s3 tests.
+
+If you are not sure how to test your pull request, you can ask the main
+developer (currently Lauri Lehmijoki) to supplement the request with tests.
+However, by including proper tests, you increase the chances of your pull
+request being incorporated into future releases.
+
 ## License
 
 MIT

data/Rakefile

@@ -6,6 +6,11 @@ task :default => 'test'
 
 desc "Run tests"
 task :test do
-    sh "bundle exec rspec"
-    sh "bundle exec cucumber --tags ~@skip-on-travis"
+  sh "bundle exec rspec"
+  sh "bundle exec cucumber --tags ~@skip-on-travis"
+end
+
+desc 'Run work-in-progress features'
+task "cucumber:wip" do
+  sh "bundle exec cucumber --tags @wip"
 end

data/changelog.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 2.2.3
+
+* Allow bugfixes for transitive dependencies *filey-diff*,
+  *simple-cloudfront-invalidator* and *configure-s3-website*, since they are
+  semantically versioned
+
 ## 2.2.2
 
 * Remove debug code that wrote the list of site files into /tmp/test.txt

data/features/{cli-output.feature → instructions-for-new-user.feature}

@@ -1,4 +1,4 @@
-Feature: Command-line interface feedback
+Feature: Instructions for a new user
 
   Scenario: Run jekyll-s3 in the wrong directory
     When I run `jekyll-s3`
@@ -7,8 +7,6 @@ Feature: Command-line interface feedback
       I can't find any directory called _site. Are you in the right directory?
       """
 
-  # For some reason this scenario fails on Travis but on on localhost
-  @skip-on-travis
   Scenario: Run jekyll-s3 for the first time
     Given a directory named "_site"
     When I run `jekyll-s3`
@@ -67,17 +65,3 @@ Feature: Command-line interface feedback
       s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
       s3_bucket: your.blog.bucket.com
       """
-
-  Scenario: Run jekyll-s3
-    Given a directory named "_site"
-    And a file named "_jekyll_s3.yml" with:
-      """
-      s3_id: YOUR_AWS_S3_ACCESS_KEY_ID
-      s3_secret: YOUR_AWS_S3_SECRET_ACCESS_KEY
-      s3_bucket: your.blog.bucket.com
-      """
-    When I run `jekyll-s3`
-    Then the output should contain:
-      """
-      Deploying _site/* to your.blog.bucket.com
-      """

data/features/jekyll-s3-as-library.feature

@@ -0,0 +1,23 @@
+Feature: Using Jekyll-s3 as a library
+
+  As a developer
+  I want to programmatically use the Jekyll-s3 API
+  So that I can extend my software with the capabilities of Jekyll-s3
+
+  @one-file-to-delete
+  Scenario: Developer wants feedback on how many files Jekyll-s3 deleted
+    When my Jekyll site is in "features/support/test_site_dirs/unpublish-a-post.com"
+    Then jekyll-s3 will push my blog to S3
+    And report that it deleted 1 file from S3
+
+  @new-and-changed-files
+  Scenario: Developer wants feedback on how many files Jekyll-s3 uploaded
+    When my Jekyll site is in "features/support/test_site_dirs/new-and-changed-files.com"
+    Then jekyll-s3 will push my blog to S3
+    And report that it uploaded 1 new and 1 changed files into S3
+
+  @s3-and-cloudfront-when-updating-a-file
+  Scenario: Developer wants feedback on how many Cloudfront items Jekyll-s3 invalidated
+    When my Jekyll site is in "features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi"
+    Then jekyll-s3 will push my blog to S3 and invalidate the Cloudfront distribution
+    And report that it invalidated 2 Cloudfront item

data/features/jekyll-s3-cloudfront.feature

@@ -9,14 +9,33 @@ Feature: Invalidate the Cloudfront distribution
   @s3-and-cloudfront
   Scenario: Upload to S3 and then invalidate the Cloudfront distribution
     When my Jekyll site is in "features/support/test_site_dirs/cdn-powered.blog.fi"
-    And the configuration contains the Cloudfront distribution id
     Then jekyll-s3 will push my blog to S3 and invalidate the Cloudfront distribution
-    And report that it uploaded 2 new and 0 changed files into S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      Uploading 2 new file(s)
+      Upload css/styles.css: Success!
+      Upload index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+      Invalidating Cloudfront items...
+        /
+      succeeded
+
+      """
 
   @s3-and-cloudfront-when-updating-a-file
   Scenario: Update a blog entry and then upload
     When my Jekyll site is in "features/support/test_site_dirs/cdn-powered.with-one-change.blog.fi"
-    And the configuration contains the Cloudfront distribution id
     Then jekyll-s3 will push my blog to S3 and invalidate the Cloudfront distribution
-    And report that it uploaded 0 new and 1 changed files into S3
-    And report that it invalidated only the changed file on Cloudfront
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      Uploading 1 changed file(s)
+      Upload index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+      Invalidating Cloudfront items...
+        /index.html
+        /
+      succeeded
+
+      """

data/features/jekyll-s3-delete.feature

@@ -8,5 +8,11 @@ Feature: remove a Jekyll blog post from S3
   Scenario: The user deletes a blog post
     When my Jekyll site is in "features/support/test_site_dirs/unpublish-a-post.com"
     Then jekyll-s3 will push my blog to S3
-    And report that it uploaded 0 new and 0 changed files into S3
-    And report that it deleted 1 file from S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      No new or changed files to upload
+      Delete index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+
+      """

data/features/jekyll-s3-upload.feature

@@ -8,22 +8,51 @@ Feature: upload Jekyll site to S3
   Scenario: Push a new Jekyll site to S3
     When my Jekyll site is in "features/support/test_site_dirs/my.blog.com"
     Then jekyll-s3 will push my blog to S3
-    And report that it uploaded 2 new and 0 changed files into S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      Uploading 2 new file(s)
+      Upload css/styles.css: Success!
+      Upload index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+
+      """
 
   @new-and-changed-files
   Scenario: Upload a new blog post and change an old post
     When my Jekyll site is in "features/support/test_site_dirs/new-and-changed-files.com"
     Then jekyll-s3 will push my blog to S3
-    And report that it uploaded 1 new and 1 changed files into S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      Uploading 1 new and 1 changed file(s)
+      Upload css/styles.css: Success!
+      Upload index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+
+      """
 
   @only-changed-files
   Scenario: Update an existing blog post
     When my Jekyll site is in "features/support/test_site_dirs/only-changed-files.com"
     Then jekyll-s3 will push my blog to S3
-    And report that it uploaded 0 new and 1 changed files into S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      Uploading 1 changed file(s)
+      Upload index.html: Success!
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+
+      """
 
   @no-new-or-changed-files
   Scenario: The user runs jekyll-s3 even though he doesn't have new or changed posts
     When my Jekyll site is in "features/support/test_site_dirs/no-new-or-changed-files.com"
     Then jekyll-s3 will push my blog to S3
-    And report that it uploaded 0 new and 0 changed files into S3
+    And the output should equal
+      """
+      Deploying _site/* to jekyll-s3-test.net
+      No new or changed files to upload
+      Done! Go visit: http://jekyll-s3-test.net.s3.amazonaws.com/index.html
+
+      """

data/features/step_definitions/steps.rb

@@ -1,3 +1,5 @@
+require 'rspec'
+
 When /^my Jekyll site is in "(.*?)"$/ do |blog_dir|
   @blog_dir = blog_dir
 end
@@ -6,38 +8,49 @@ When /^jekyll-s3 will push my blog to S3$/ do
   do_run
 end
 
-When /^the configuration contains the Cloudfront distribution id$/ do
-  # Just here for readability
-end
-
 Then /^jekyll-s(\d+) will push my blog to S(\d+) and invalidate the Cloudfront distribution$/ do
   |arg1, arg2|
   do_run
 end
 
+Then /^the output should equal$/ do |expected_console_output|
+  @console_output.should eq(expected_console_output)
+end
+
 Then /^report that it uploaded (\d+) new and (\d+) changed files into S3$/ do
   |new_count, changed_count|
-  raise unless @amount_of_new_files == new_count.to_i
-  raise unless @amount_of_changed_files == changed_count.to_i
+  @amount_of_new_files.should == new_count.to_i
+  @amount_of_changed_files.should == changed_count.to_i
 end
 
-Then /^report that it deleted (\d+) file from S3$/ do |amount_of_deleted_files|
-  raise unless @amount_of_deleted_files == amount_of_deleted_files.to_i
+Then /^report that it invalidated (\d+) Cloudfront item$/ do |expected|
+  @amount_of_invalidated_items.should == expected.to_i
 end
 
-Then /^report that it invalidated only the changed file on Cloudfront$/ do
-  # The Cloudfront root object is always invalidated;
-  # it counts as an invalidation.
-  root_object_count = 1
-  changed_files = 1
-  raise unless @amount_of_invalidated_items == root_object_count + changed_files
+Then /^report that it deleted (\d+) file from S3$/ do |amount_of_deleted_files|
+  @amount_of_deleted_files.should == amount_of_deleted_files.to_i
 end
 
 def do_run
-  in_headless_mode = true
-  result = Jekyll::S3::CLI.new.run("#{@blog_dir}/_site", in_headless_mode)
-  @amount_of_new_files = result[:new_files_count]
-  @amount_of_changed_files = result[:changed_files_count]
-  @amount_of_deleted_files = result[:deleted_files_count]
-  @amount_of_invalidated_items = result[:invalidated_items_count]
+  @console_output = capture_stdout {
+    in_headless_mode = true
+    result = Jekyll::S3::CLI.new.run("#{@blog_dir}/_site", in_headless_mode)
+    @amount_of_new_files = result[:new_files_count]
+    @amount_of_changed_files = result[:changed_files_count]
+    @amount_of_deleted_files = result[:deleted_files_count]
+    @amount_of_invalidated_items = result[:invalidated_items_count]
+  }
+end
+
+module Kernel
+  require 'stringio'
+
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    out.string
+  ensure
+    $stdout = STDOUT
+  end
 end

data/features/support/env.rb

@@ -18,7 +18,9 @@ After do
 end
 # End of following from 'aruba/cucumber'
 
-Then /^the file "([^"]*)" should contain:$/ do |file, exact_content|
-  check_file_content(file, exact_content, true)
+# Disable colored gem. Its difficult to test output when it contains colored strings.
+module Colored
+  def colorize(string, options = {})
+    string
+  end
 end
-

data/jekyll-s3.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "jekyll-s3"
-  s.version     = "2.2.2"
+  s.version     = "2.2.3"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]
@@ -16,16 +16,16 @@ distribution, making it easy to deliver your blog via the CDN.}
   s.default_executable = %q{jekyll-s3}
 
   s.add_dependency 'aws-sdk', '~> 1.8.0'
-  s.add_dependency 'filey-diff', '~> 1.0.0'
-  s.add_dependency 'simple-cloudfront-invalidator', '~> 1.0.0'
+  s.add_dependency 'filey-diff', '~> 1.0'
+  s.add_dependency 'simple-cloudfront-invalidator', '~> 1.0'
   s.add_dependency 'erubis', '~> 2.7.0'
   s.add_dependency 'mime-types', '= 1.19'
-  s.add_dependency 'configure-s3-website', '~> 1.0.0'
+  s.add_dependency 'configure-s3-website', '~> 1.0'
 
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-expectations'
   s.add_development_dependency 'cucumber'
-  s.add_development_dependency 'aruba', '>= 0.4.7'
+  s.add_development_dependency 'aruba', '~> 0.5.1'
   s.add_development_dependency 'rake'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock', '~> 1.8.0'

data/spec/lib/retry_spec.rb

@@ -11,7 +11,7 @@ describe Jekyll::S3::Retry do
         }
       rescue
       end
-      retries.should be (4)
+      retries.should be(4)
     end
 
     it "throws an error if all retries fail" do
@@ -28,7 +28,7 @@ describe Jekyll::S3::Retry do
         retries += 1
         raise Exception if retries < 2
       }
-      retries.should be (2)
+      retries.should be(2)
     end
   end
 end

data/spec/lib/upload_spec.rb

@@ -87,12 +87,18 @@ describe Jekyll::S3::Uploader do
   end
 
   context '#load_all_local_files' do
-    describe 'dotfile support' do
-      it 'loads also dotfiles' do
-        files = Jekyll::S3::Uploader.send(:load_all_local_files,
-                                        'spec/sample_files/hyde_site/_site')
-        files.should eq(['index.html', '.vimrc'])
-      end
+    let(:files) {
+      Jekyll::S3::Uploader.send(:load_all_local_files,
+                                'spec/sample_files/hyde_site/_site')
+    }
+
+    it 'loads regular files' do
+      files.should include('css/styles.css')
+      files.should include('index.html')
+    end
+
+    it 'loads also dotfiles' do
+      files.should include('.vimrc')
     end
   end
 end

data/spec/sample_files/hyde_site/_site/css/styles.css

@@ -0,0 +1,3 @@
+body {
+
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-31 00:00:00.000000000 Z
+date: 2013-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -35,7 +35,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -43,7 +43,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: simple-cloudfront-invalidator
   requirement: !ruby/object:Gem::Requirement
@@ -51,7 +51,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -59,7 +59,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: erubis
   requirement: !ruby/object:Gem::Requirement
@@ -99,7 +99,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -107,7 +107,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -161,17 +161,17 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.5.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: 0.4.7
+        version: 0.5.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -247,7 +247,8 @@ files:
 - features/cassettes/cucumber_tags/only-changed-files.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront-when-updating-a-file.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront.yml
-- features/cli-output.feature
+- features/instructions-for-new-user.feature
+- features/jekyll-s3-as-library.feature
 - features/jekyll-s3-cloudfront.feature
 - features/jekyll-s3-delete.feature
 - features/jekyll-s3-upload.feature
@@ -290,6 +291,7 @@ files:
 - spec/lib/upload_spec.rb
 - spec/sample_files/hyde_site/_jekyll_s3.yml
 - spec/sample_files/hyde_site/_site/.vimrc
+- spec/sample_files/hyde_site/_site/css/styles.css
 - spec/sample_files/hyde_site/_site/index.html
 - spec/spec_helper.rb
 homepage: https://github.com/laurilehmijoki/jekyll-s3
@@ -324,7 +326,8 @@ test_files:
 - features/cassettes/cucumber_tags/only-changed-files.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront-when-updating-a-file.yml
 - features/cassettes/cucumber_tags/s3-and-cloudfront.yml
-- features/cli-output.feature
+- features/instructions-for-new-user.feature
+- features/jekyll-s3-as-library.feature
 - features/jekyll-s3-cloudfront.feature
 - features/jekyll-s3-delete.feature
 - features/jekyll-s3-upload.feature
@@ -357,5 +360,6 @@ test_files:
 - spec/lib/upload_spec.rb
 - spec/sample_files/hyde_site/_jekyll_s3.yml
 - spec/sample_files/hyde_site/_site/.vimrc
+- spec/sample_files/hyde_site/_site/css/styles.css
 - spec/sample_files/hyde_site/_site/index.html
 - spec/spec_helper.rb