jekyll-s3 2.4.3 → 2.5.0

data/README.md

@@ -96,6 +96,15 @@ s3_endpoint: ap-northeast-1
 The valid `s3_endpoint` values consist of the [S3 location constraint
 values](http://docs.amazonwebservices.com/general/latest/gr/rande.html#s3_region).
 
+### Ignoring files you want to keep on AWS
+
+Sometimes there are files or directories you want to keep on S3, but not on
+your local machine. You may define a regular expression to ignore files like so: 
+
+```yaml
+ignore_on_server: that_folder_of_stuff_i_dont_keep_locally
+```
+
 ### Reduced Redundancy
 
 You can reduce the cost of hosting your blog on S3 by using Reduced Redundancy Storage:
@@ -125,16 +134,32 @@ bucket that are not on your local computer.
 Enable the headless mode by adding the `--headless` or `-h` argument after
 `jekyll-s3`.
 
-## Using `jekyll-s3` as a library
+### Using `jekyll-s3` as a library
 
 By nature, `jekyll-s3` is a command-line interface tool. You can, however, use
 it programmatically by calling the same API as the executable `jekyll-s3` does:
 
 ````ruby
+require 'jekyll-s3'
 is_headless = true
 Jekyll::S3::CLI.new.run('/path/to/your/jekyll-site/_site/', is_headless)
 ````
 
+You can also use a basic `Hash` instead of a `_jekyll_s3.yml` file:
+
+```ruby
+config = {
+  "s3_id"     => YOUR_AWS_S3_ACCESS_KEY_ID,
+  "s3_secret" => YOUR_AWS_S3_SECRET_ACCESS_KEY,
+  "s3_bucket" => your.blog.bucket.com
+}
+in_headless = true
+Jekyll::S3::Uploader.run('/path/to/your/jekyll-site/_site/', config, in_headless)
+```
+
+The code above will assume that you have the `_jekyll_s3.yml` in the directory
+`/path/to/your/jekyll-site`.
+
 ## Known issues
 
 None. Please send a pull request if you spot any.
@@ -175,6 +200,7 @@ MIT
 Copyright (c) 2011 VersaPay, Philippe Creux.
 
 Contributors (in alphabetical order)
+* Alan deLevie
 * Cory Kaufman-Schofield
 * Chris Kelly
 * Chris Moos

data/changelog.md

@@ -2,6 +2,10 @@
 
 This project uses [Semantic Versioning](http://semver.org).
 
+## 2.5.0
+
+* Use regex to ignore files on server
+
 ## 2.4.3
 
 * Make `s3_endpoint` optional in `_jekyll_s3.yml` when using `jekyll-s3` as a

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.4.3"
+  s.version     = "2.5.0"
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Philippe Creux", "Lauri Lehmijoki"]
   s.email       = ["pcreux@gmail.com", "lauri.lehmijoki@iki.fi"]

data/lib/jekyll-s3/uploader.rb

@@ -12,8 +12,10 @@ module Jekyll
           s3, config, site_dir
         )
 
-        deleted_files_count = remove_superfluous_files(
-          s3, config['s3_bucket'], site_dir, in_headless_mode)
+        deleted_files_count = remove_superfluous_files(s3, { :s3_bucket => config['s3_bucket'],
+                                                             :site_dir => site_dir,
+                                                             :in_headless_mode => in_headless_mode,
+                                                             :ignore_on_server => config["ignore_on_server"] })
 
         print_done_report config
 
@@ -63,10 +65,16 @@ module Jekyll
         end
       end
 
-      def self.remove_superfluous_files(s3, s3_bucket_name, site_dir, in_headless_mode)
+      def self.remove_superfluous_files(s3, options)
+        s3_bucket_name = options.fetch(:s3_bucket)
+        site_dir = options.fetch(:site_dir)
+        in_headless_mode = options.fetch(:in_headless_mode)
+
         remote_files = s3.buckets[s3_bucket_name].objects.map { |f| f.key }
         local_files = load_all_local_files(site_dir)
-        files_to_delete = remote_files - local_files
+        files_to_delete = build_list_of_files_to_delete(remote_files, local_files, options[:ignore_on_server])
+
+
         deleted_files_count = 0
         if in_headless_mode
           files_to_delete.each { |s3_object_key|
@@ -82,6 +90,12 @@ module Jekyll
         deleted_files_count
       end
 
+      def self.build_list_of_files_to_delete(remote_files, local_files, ignore_on_server = nil)
+        ignore_on_server = Regexp.new(ignore_on_server || "a_string_that_should_never_match_ever")
+        files_to_delete = remote_files - local_files
+        files_to_delete.reject { |file| ignore_on_server.match(file) }
+      end
+
       def self.delete_s3_object(s3, s3_bucket_name, s3_object_key)
         Retry.run_with_retry do
           s3.buckets[s3_bucket_name].objects[s3_object_key].delete

data/spec/lib/uploader_spec.rb

@@ -16,4 +16,15 @@ describe Jekyll::S3::Uploader do
       files.should include('.vimrc')
     end
   end
+
+  context "#build_list_of_files_to_delete" do
+    it "ignores files which match a regular expression" do
+      files_to_delete = Jekyll::S3::Uploader.build_list_of_files_to_delete(["a", "b", "ignored"], ["a"], "ignored")
+      files_to_delete.should eq ["b"]
+    end
+    it "does not ignore when you don't provide an ignored regex" do
+      files_to_delete = Jekyll::S3::Uploader.build_list_of_files_to_delete(["a", "b", "ignored"], ["a"])
+      files_to_delete.should eq ["b", "ignored"]
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-s3
 version: !ruby/object:Gem::Version
-  version: 2.4.3
+  version: 2.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-09 00:00:00.000000000 Z
+date: 2013-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -331,15 +331,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 392463145716040126
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 392463145716040126
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Push your Jekyll blog to S3