octopress-deploy 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a5d520dee46302f639264c81e76613c9de457c64
-  data.tar.gz: e6b2c40263b4bedbb03572279950d1c6fff02367
+  metadata.gz: e9d2703f3a60fefc2dad07bed5c89667893aaced
+  data.tar.gz: 2186ef8eb38190518f08e43ac60962b0c635a51f
 SHA512:
-  metadata.gz: 3c079408b162fe4e49d40020b891c43ec1741444250f5d6b22e99e96d3132b79049bb45ecc0d4a72f063004a6b91fb6ba88852df24aba417d70cfaa2f65884b3
-  data.tar.gz: fb5cafd7fbb2bfd8f72261c7150f8dabf16d0e97bf5a0fd709b2eed03aa85c6c2adfab679444469b3c9bfe2b45388810474a9b8b8853a0bc98cc10155c2cf4c5
+  metadata.gz: 7d7ed8e4498f809bcdef3ef2ffe14b498485a3efa2fa0e3069f94f041a019dc8d09ba50862b9e3c5541a45dcba273f4ce46988bfa1cee86d2dd2c685a46c4db9
+  data.tar.gz: 4c928e03d4248bde22c379365446a63bc33b9c2a01263b80d773c1276b65bc30840ef03dc79325b1d0dd33401339abd675435c3de6dba75d6b815eb8bbf7d792

data/.clash.yml

@@ -0,0 +1,53 @@
+-
+  tasks:
+    cleanup:
+      - rm -rf build local-rsync pull-rsync pull-s3 .deploy pull-git local-git pull-s3 remote-rsync
+    reset: 
+      - cleanup
+      - cp -r source/ _site
+      - ruby garbage.rb
+-
+  title: Test local Rsync
+  before: 
+    - reset
+    - octopress deploy init rsync --dir local-rsync --config _rsync_deploy_local.yml --force
+    - octopress deploy --config _rsync_deploy_local.yml
+  compare: _site local-rsync
+
+-
+  title: Test remote Rsync
+  before: 
+    - reset
+    - octopress deploy --config _rsync_deploy.yml
+    - octopress deploy pull pull-rsync --config _rsync_deploy.yml
+  compare: _site pull-rsync
+
+-
+  title: Test local Git
+  before: 
+    - reset
+    - git init --bare local-git
+    - octopress deploy init git --branch test_git_deploy --url ./local-git --dir site --config _git_deploy_local.yml --force
+    - octopress deploy --config _git_deploy_local.yml
+    - octopress deploy pull pull-git --config _git_deploy_local.yml
+    - rm -rf pull-git/.git
+  compare: _site pull-git/site
+
+-
+  title: Test remote Git
+  before: 
+    - reset
+    - octopress deploy init git --branch test_git_deploy --url git@github.com:octopress/deploy --config _git_deploy.yml --force
+    - octopress deploy --config _git_deploy.yml
+    - octopress deploy pull pull-git --config _git_deploy.yml
+    - rm -rf pull-git/.git
+  compare: _site pull-git
+
+-
+  title: Test S3
+  before: 
+    - reset
+    - octopress deploy s3 --config _s3_deploy.yml
+    - octopress deploy pull pull-s3 --config _s3_deploy.yml
+  compare: _site pull-s3
+  after: cleanup

data/.gitignore

@@ -27,3 +27,4 @@ build
 local-git
 local-rsync
 .DS_Store
+_site

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Octopress Deploy Changelog
 
+###  1.0.1 - 2014-12-27
+- Added command line options for setting contents of config file
+- Added support for Octopress docs
+
+### 1.0.0 - 2014-09-24
+- Deemed suitable for use
+
 ###  1.0.0 RC11 - 2014-07-06
 - Fix: Changed git add command to be more broadly suitable.
 

data/README.md

@@ -24,6 +24,13 @@ directory which you can edit to add any necessary configuration.
 **Remember to add your configuration to `.gitignore` to be sure
 you never commit sensitive information to your repository.**
 
+You can pass configurations as command line options. To see specific options for any method, add the `--help` flag.
+For example to see the options for configuring S3:
+
+```sh
+$ octopress deploy init s3 --help
+```
+
 ## Deploying your site.
 
 Deployment is tailored to work with Jekyll, but it will work for
@@ -157,8 +164,9 @@ Only `git_url` is required. Other options will default as shown below.
 | `user`         | ssh user, e.g user@host.com                       |                |
 | `port`         | ssh port                                          | 22             |
 | `remote_path`  | Remote destination's document root                |                |
-| `exclude_file` | Path to a file containing rsync exclusions        |                |
+| `exclude_from` | Path to a file containing rsync exclusions        |                |
 | `exclude`      | Inline list of rsync exclusions                   |                |
+| `include_from` | Path to a file containing rsync inclusions        |                |
 | `include`      | Inline list of inclusions to override exclusions  |                |
 | `delete`       | Delete files in destination not found in source   | false          |
 

data/lib/octopress-deploy.rb

@@ -141,3 +141,10 @@ FILE
 
   end
 end
+
+Octopress::Docs.add({
+  name:        "Octopress Deploy",
+  description: "An Octopress plugin for deploying static websites.",
+  path:        File.expand_path(File.join(File.dirname(__FILE__), "../")),
+  source_url:  "https://github.com/octopress/deploy",
+})

data/lib/octopress-deploy/commands.rb

@@ -26,11 +26,55 @@ module Octopress
           c.command(:init) do |c|
             c.syntax 'init <METHOD> [options]'
             c.description "Create a configuration file for a deployment method (#{Deploy::METHODS.keys.join(', ')})."
-            c.option 'force', '--force', 'Initialize a config file even if it already exists.'
 
-            c.action do |args, options|
-              options['method'] = args.first
-              Octopress::Deploy.init_config(options)
+            c.command(:rsync) do |c|
+              c.syntax 'rsync [options]'
+              c.description "Create an rsync deployment configuration file."
+              c.option 'user', '-u', '--user USER', 'SSH user (e.g. username@host.org)'
+              c.option 'port', '-p', '--port PORT', 'SSH port (default: 22)'
+              c.option 'flags', '-f', '--flags FLAGS', 'Flags to pass to Rsync command (default: -avz)'
+              c.option 'remote_path', '--dir DIR', 'Path to site directory on host (e.g. ~/webroot/)'
+              c.option 'delete', '--delete', 'Sync file deletion'
+              add_common_init_options(c)
+
+              c.action do |args, options|
+                options['method'] = 'rsync'
+                Octopress::Deploy.init_config(options)
+              end
+            end
+
+            c.command(:git) do |c|
+              c.syntax 'git [options]'
+              c.description "Create a git deployment configuration file."
+              c.option 'git_url', '-u', '--url URL', 'Git url (e.g. git@github.com:user/project)'
+              c.option 'git_branch', '-b', '--branch NAME', 'Branch to deploy to (default: master)'
+              c.option 'remote_path', '-d', '--dir DIR', 'Deploy site into a subdirectory.'
+              c.option 'delete', '--delete', 'Sync file deletion'
+              add_common_init_options(c)
+
+              c.action do |args, options|
+                options['method'] = 'git'
+                options['git_url'].sub!(/^\./, Dir.pwd)
+                Octopress::Deploy.init_config(options)
+              end
+            end
+
+            c.command(:s3) do |c|
+              c.syntax 's3 [options]'
+              c.description "Create an S3 deployment configuration file."
+              c.option 'bucket_name', '-b', '--bucket NAME', 'S3 Bucket name'
+              c.option 'access_key_id', '-a', '--access KEY', 'Access key id'
+              c.option 'secret_access_key', '-s', '--secret KEY', 'Secret access key'
+              c.option 'region', '-r', '--region REGION', 'AWS region (default: us-east-1)'
+              c.option 'remote_path', '-d', '--dir DIR', 'Deploy site into a subdirectory.'
+              c.option 'verbose', '-v', '--verbose', 'Log verbose output when deploying (default: true)'
+              c.option 'delete', '--delete', 'Sync file deletion'
+              add_common_init_options(c)
+
+              c.action do |args, options|
+                options['method'] = 's3'
+                Octopress::Deploy.init_config(options)
+              end
             end
           end
 
@@ -49,6 +93,12 @@ module Octopress
           end
         end
       end
+
+      def self.add_common_init_options(c)
+        c.option 'site_dir', '--site', 'Path to generated site (default: _site).'
+        c.option 'force', '--force', 'Overwrite any exiting config file.'
+        c.option 'config_file', '--config FILE', 'Choose a config file name. (default. _deploy.yml)'
+      end
     end
   end
 end

data/lib/octopress-deploy/rsync.rb

@@ -10,11 +10,11 @@ module Octopress
         @local        = @options[:site_dir] || '_site'
         @remote_path  = @options[:remote_path]
         @exclude      = @options[:exclude]
-        @exclude_file = @options[:exclude_file]
-        @exclude_file = File.expand_path(@exclude_file) if @exclude_file
+        @exclude_from = @options[:exclude_from]
+        @exclude_from = File.expand_path(@exclude_from) if @exclude_from
         @include      = @options[:include]
-        @exclude_file = @options[:include_file]
-        @exclude_file = File.expand_path(@include_file) if @include_file
+        @exclude_from = @options[:include_from]
+        @exclude_from = File.expand_path(@include_from) if @include_from
         @delete       = @options[:delete] || false
         @pull_dir     = @options[:dir]
       end
@@ -35,10 +35,10 @@ module Octopress
 
         cmd    =  "rsync "
         cmd    << "#{@flags} "
-        cmd    << " -e"                               if @exclude_file || @exclude
-        cmd    << " --exclude-from #{@exclude_file}"  if @exclude_file
+        cmd    << " -e"                               if @exclude_from || @exclude
+        cmd    << " --exclude-from #{@exclude_from}"  if @exclude_from
         cmd    << " --exclude #{@exclude}"            if @exclude
-        cmd    << " --include-from #{@include_file}"  if @include_file
+        cmd    << " --include-from #{@include_from}"  if @include_from
         cmd    << " --include #{@include}"            if @include
         cmd    << " --rsh='ssh -p#{@port}'"           if @user && @port
         cmd    << " --delete "                        if @delete
@@ -59,13 +59,13 @@ module Octopress
 #{"user: #{options[:user]}".ljust(40)}  # The user for your host, e.g. user@host.com
 #{"remote_path: #{options[:remote_path]}".ljust(40)}  # Destination directory
 #{"delete: #{options[:delete]}".ljust(40)}  # Remove files from destination which don't match files in source
+#{"port: #{options[:port]}".ljust(40)}  # If your host requires a non standard port
+#{"flags: #{options[:flags] || ' -avz'}".ljust(40)}  # Modify flags as necessary to suit your hosting setup
 
-#{"# flags: #{options[:flags] || '-rltDvz'}".ljust(40)}  # Modify flags as necessary to suit your hosting setup
-#{"# port: #{options[:port]}".ljust(40)}  # If your host requires a non standard port
-#{"# exclude: ".ljust(40)}  # Path to file containing list of files to exclude
-#{"# exclude-file: ".ljust(40)}  # Path to file containing list of files to exclude
-#{"# include: ".ljust(40)}  # Path to file containing list of files to include
-#{"# include-file: ".ljust(40)}  # Path to file containing list of files to include
+#{"# exclude: ".ljust(40)}  # files to exclude
+#{"# exclude-from: ".ljust(40)}  # Path to file containing list of files to exclude
+#{"# include: ".ljust(40)}  # files to include
+#{"# include-from: ".ljust(40)}  # Path to file containing list of files to include
 CONFIG
       end
       

data/lib/octopress-deploy/s3.rb

@@ -219,8 +219,8 @@ module Octopress
 #{"access_key_id: #{options[:access_key_id]}".ljust(40)}  # Get this from your AWS console at aws.amazon.com.
 #{"secret_access_key: #{options[:secret_access_key]}".ljust(40)}  # Keep it safe; keep it secret. Keep this file in your .gitignore.
 #{"remote_path: #{options[:remote_path] || '/'}".ljust(40)}  # relative path on bucket where files should be copied.
+#{"region: #{options[:remote_path] || 'us-east-1'}".ljust(40)}  # Region where your bucket is located.
 
-#{"# region: #{options[:region] || 'us-east-1'}".ljust(40)}  # Region where your bucket is located.
 #{"# delete: #{options[:delete] || 'true'}".ljust(40)}  # Remove files from destination which do not match source files.
 #{"# verbose: #{options[:verbose] || 'true'}".ljust(40)}  # Print out all file operations.
 CONFIG

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0"
+    VERSION = "1.0.1"
   end
 end

data/octopress-deploy.gemspec

@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "octopress"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "clash"
+  spec.add_development_dependency "aws-sdk"
 
   if RUBY_VERSION >= "2"
     spec.add_development_dependency "pry-byebug"

data/test/_git_deploy_local.yml

@@ -0,0 +1,12 @@
+method: git                               # How do you want to deploy? git, rsync or s3.
+site_dir: _site                           # Location of your your static site files.
+
+git_url: /Users/imathis/workspace/octodev/deploy/test/local-git  # remote repository url, e.g. git@github.com:username/repo_name
+
+# Note on git_branch:
+# If using GitHub project pages, set the branch to 'gh-pages'.
+# For GitHub user/organization pages or Heroku, set the branch to 'master'.
+#
+git_branch: test_git_deploy               # Git branch where static site files are commited
+
+remote_path: site                       # Destination directory

data/test/_rsync_deploy_local.yml

@@ -0,0 +1,13 @@
+method: rsync                             # How do you want to deploy? git, rsync or s3.
+site_dir: _site                           # Location of your your static site files.
+
+user:                                     # The user for your host, e.g. user@host.com
+remote_path: local-rsync                  # Destination directory
+delete:                                   # Remove files from destination which don't match files in source
+port:                                     # If your host requires a non standard port
+flags:  -avz                              # Modify flags as necessary to suit your hosting setup
+
+# exclude:                                # files to exclude
+# exclude-from:                           # Path to file containing list of files to exclude
+# include:                                # files to include
+# include-from:                           # Path to file containing list of files to include

data/test/garbage.rb

@@ -0,0 +1,14 @@
+require 'find'
+
+def add_garbage
+  Find.find('_site').to_a.each do |f| 
+    system("echo '#{garbage}' >> #{f}") unless File.directory?(f)
+  end
+end
+
+def garbage
+  o = [('a'..'z'), ('A'..'Z')].map { |i| i.to_a }.flatten
+  (0...50).map { o[rand(o.length)] }.join
+end
+
+add_garbage

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-25 00:00:00.000000000 Z
+date: 2014-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colorator
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: clash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
@@ -101,6 +129,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".clash.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -118,8 +147,9 @@ files:
 - octopress-deploy.gemspec
 - test/.gitignore
 - test/Gemfile
-- test/_deploy_rsync.yml
-- test/_deploy_rsync_local.yml
+- test/_git_deploy_local.yml
+- test/_rsync_deploy_local.yml
+- test/garbage.rb
 - test/source/.hidden
 - test/source/dir/file
 - test/source/test_file
@@ -144,15 +174,16 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Easily deploy any Jekyll or Octopress site using S3, Git, or Rsync.
 test_files:
 - test/.gitignore
 - test/Gemfile
-- test/_deploy_rsync.yml
-- test/_deploy_rsync_local.yml
+- test/_git_deploy_local.yml
+- test/_rsync_deploy_local.yml
+- test/garbage.rb
 - test/source/.hidden
 - test/source/dir/file
 - test/source/test_file

data/test/_deploy_rsync.yml

@@ -1,6 +0,0 @@
-method: rsync
-site_dir: build
-user: imathis@imathis.com
-port: 
-remote_path: ~/octopress-deploy/rsync/
-delete:

data/test/_deploy_rsync_local.yml

@@ -1,6 +0,0 @@
-method: rsync
-site_dir: build
-user: 
-port: 
-remote_path: local-rsync
-delete: