octopress-deploy 1.0.0.rc.5 → 1.0.0.rc.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f09b31e6aa0f3d103e61dc12c6d16104c6beb07f
-  data.tar.gz: 82554203c1788bf4a3daff348013d4dd457bfc69
+  metadata.gz: 4c467df4b3e393b8f56f2416e57d0cdb38fe912f
+  data.tar.gz: 318d2b394f037d4c8d22aff61e1eaa9a932e7b57
 SHA512:
-  metadata.gz: 58171d42cffb38df63f6626ea6301bea6d2f411dca39541464b3523cde913097ca9ffd63fb9fb8aaeba29d4bcbb7ab01965332cbfd15fe89c578e891f05c854e
-  data.tar.gz: b63e8b106dd950ee6646fb2f2e9ea3832a3b4c9286cfa49d5b4ee2fa36ba5f6bdc3e8f959d0f6d2479c7a14cb775420a1742897a80b4ef72e58f5d7a58f96f73
+  metadata.gz: fdd39fed5216d0aa542719c5831e9954bc0b88c7b8af08476524470970055510472a53753021a36d34badf2ab8fdd79ff03d7ef2a71e670f46f5551e357ad184
+  data.tar.gz: ea58b46c376c30140c713eea0e754adcdcc2d1e69976ee99df31af03d7b273a5a3bf1c9e866123c93caa10e08a8368f8229e78381873aed0ef81c7a7a13dee73

data/.gitignore

@@ -23,6 +23,7 @@ _git_deploy.yml
 pull-git
 pull-rsync
 pull-s3
-_site
+build
 local-git
 local-rsync
+.DS_Store

data/CHANGELOG.md

@@ -2,13 +2,18 @@
 
 ## Current version
 
+### 1.0.0 RC6 - 2014-04-17
+
+- Fixed: CLI options now override config file settings.
+
+## Past versions
+
 ### 1.0.0 RC5 - 2014-04-01
 
 - Fixed: `site_dir` config didn't work.
 
-## Past versions
 
-### 1.0.0 RC4 - 2014-03-22
+### 1.0.0 RC4 - 2014-03-25
 
 - Added: Octopress Ink documentation site support
 

data/assets/docs/changelog.markdown

@@ -5,6 +5,21 @@ permalink: /changelog/
 
 ## Current version
 
+### 1.0.0 RC6 - 2014-04-17
+
+- Fixed: CLI options now override config file settings.
+
+## Past versions
+
+### 1.0.0 RC5 - 2014-04-01
+
+- Fixed: `site_dir` config didn't work.
+
+
+### 1.0.0 RC4 - 2014-03-25
+
+- Added: Octopress Ink documentation site support
+
 ### 1.0.0 RC3 - 2014-03-22
 
 #### Minor Enhancements
@@ -19,7 +34,6 @@ permalink: /changelog/
 - No longer stripping forward slashes on remote_path. Issue #18
 - `pull` command no longer promises a default directory.
 
-## Past versions
 
 ### 1.0.0 RC2 - 2014-03-18
 - CHANGE: `add_bucket` command becomes `add-bucket` 

data/lib/octopress-deploy/git.rb

@@ -43,16 +43,18 @@ module Octopress
       end
 
       def self.default_config(options={})
-        <<-CONFIG
+        config = <<-CONFIG
 #{"git_url: #{options[:git_url]}".ljust(40)}  # remote repository url, e.g. git@github.com:username/repo_name
-#{"git_branch: #{options[:git_branch] || 'master'}".ljust(40)}  # Git branch where static site files are commited
 
 # 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: #{options[:git_branch] || 'master'}".ljust(40)}  # Git branch where static site files are commited
 
-#{"# remote_path: #{options[:remote_path]}".ljust(40)}  # Destination directory
 CONFIG
+        config << "\n# " unless options[:remote_path]
+        config << "#{"remote_path: #{options[:remote_path]}".ljust(38)}  # Destination directory"
       end
 
       # If necessary create deploy directory and initialize it with deployment remote.

data/lib/octopress-deploy/rsync.rb

@@ -4,7 +4,7 @@ module Octopress
 
       def initialize(options)
         @options      = options
-        @flags        = @options[:flags] || ' -rltDvz'
+        @flags        = @options[:flags] || ' -avz'
         @user         = @options[:user]
         @port         = @options[:port]
         @local        = @options[:site_dir]
@@ -41,7 +41,7 @@ module Octopress
         cmd    << " --include-from #{@include_file}"  if @include_file
         cmd    << " --include #{@include}"            if @include
         cmd    << " --rsh='ssh -p#{@port}'"           if @user && @port
-        cmd    << " --delete"                         if @delete
+        cmd    << " --delete "                        if @delete
 
         local  << " #{File.join(@local, '')} "
         remote << " #{@user}:"                         if @user

data/lib/octopress-deploy/s3.rb

@@ -9,7 +9,7 @@ module Octopress
         begin
           require 'aws-sdk'
         rescue LoadError
-          abort "Please install the aws-sdk gem first."
+          abort "Deploying to S3 requires aws-sdk. Install with `gem install aws-sdk`."
         end
         @options     = options
         @local       = options[:site_dir]

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0.rc.5"
+    VERSION = "1.0.0.rc.6"
   end
 end

data/lib/octopress-deploy.rb

@@ -1,5 +1,7 @@
 $LOAD_PATH.unshift File.expand_path("../", __FILE__)
 #
+require 'pry-debugger'
+
 require 'colorator'
 require 'yaml'
 require 'octopress'
@@ -20,57 +22,61 @@ module Octopress
       's3'    => S3
     }
 
+    DEFAULT_OPTIONS = {
+      :config_file => '_deploy.yml',
+      :site_dir => '_site',
+    }
+
     def self.push(options={})
-      init_options(options)
-      if !File.exists? @options[:config_file]
-        abort "File not found: #{@options[:config_file]}. Create a deployment config file with `octopress deploy init <METHOD>`."
-      else
-        parse_options
-        deploy_method.new(@options).push()
-      end
+      options = merge_configs(options)
+      deployer(options).push
     end
 
     def self.pull(options={})
-      init_options(options)
-      if !File.exists? @options[:config_file]
-        abort "No deployment config found. Create one with: octopress deploy init #{@options[:config_file]}"
-      else
-        parse_options
-        if !File.exists? @options[:dir]
-          FileUtils.mkdir_p @options[:dir]
-        end
-        deploy_method.new(@options).pull()
+      options = merge_configs(options)
+
+      if !File.exists? options[:dir]
+        FileUtils.mkdir_p options[:dir]
       end
+
+      deployer(options).pull
     end
 
     def self.add_bucket(options={})
-      init_options(options)
-      if !File.exists? @options[:config_file]
-        abort "File not found: #{@options[:config_file]}. Create a deployment config file with `octopress deploy init <METHOD>`."
-      else
-        parse_options
-        deploy_method.new(@options).add_bucket()
-      end
+      options = merge_configs(options)
+      get_deployment_method(options).new().add_bucket()
+    end
+
+    def self.merge_configs(options={})
+      options = check_config(options)
+      config  = YAML.load(File.open(options[:config_file])).to_symbol_keys
+      options = config.deep_merge(options)
     end
 
-    def self.parse_options
-      config  = YAML.load(File.open(@options[:config_file])).to_symbol_keys
-      @options = @options.to_symbol_keys
-      @options = config.deep_merge(@options)
+    def self.check_config(options={})
+      options = options.to_symbol_keys
+      options[:config_file] ||= DEFAULT_OPTIONS[:config_file]
+
+      if !File.exists? options[:config_file]
+        abort "File not found: #{options[:config_file]}. Create a deployment config file with `octopress deploy init <METHOD>`."
+      end
+
+      options
     end
 
-    def self.init_options(options={})
-      @options                 = options.to_symbol_keys
-      @options[:config_file] ||= '_deploy.yml'
-      @options[:site_dir]    ||= site_dir
+    def self.deployer(options)
+      get_deployment_method(options).new(options)
     end
 
-    def self.deploy_method
-      METHODS[@options[:method].downcase]
+    def self.get_deployment_method(options)
+      METHODS[options[:method].downcase]
     end
 
+
     def self.site_dir
-      @options[:site_dir] || if File.exist? '_config.yml'
+      if options[:site_dir]
+        options[:site_dir]
+      elsif File.exist? '_config.yml'
         YAML.load(File.open('_config.yml'))['site_dir'] || '_site'
       else
         '_site'
@@ -86,7 +92,7 @@ module Octopress
         abort "Please provide a deployment method. e.g. #{METHODS.keys}"
       end
 
-      init_options(options)
+      @options = DEFAULT_OPTIONS.deep_merge(options)
       write_config
       check_gitignore
     end
@@ -110,7 +116,7 @@ module Octopress
 #{"method: #{@options[:method]}".ljust(40)}  # How do you want to deploy? git, rsync or s3.
 #{"site_dir: #{@options[:site_dir]}".ljust(40)}  # Location of your your static site files.
 
-#{deploy_method.default_config(@options)}
+#{get_deployment_method(@options).default_config(@options)}
 FILE
     end
 

data/test/_deploy_rsync.yml

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

data/test/_deploy_rsync_local.yml

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

data/test/test.rb

@@ -6,13 +6,13 @@ require 'find'
 @failures = {}
 
 def setup_tests
-  `rm -rf _site` # clean up from previous tests
+  `rm -rf build` # clean up from previous tests
   generate_site
 end
 
 def generate_site
-  system "cp -r source/ _site"
-  Find.find('_site').to_a.each do |f| 
+  system "cp -r source/ build"
+  Find.find('build').to_a.each do |f| 
     system("echo '#{garbage}' >> #{f}") unless File.directory?(f)
   end
 end
@@ -67,10 +67,10 @@ def test_remote_git
   
   # Test remote git deployment
   #
-  Octopress::Deploy.init_config(method: 'git', config_file: config, force: true, git_branch: 'test_git_deploy', git_url: repo)
+  Octopress::Deploy.init_config(method: 'git', config_file: config, force: true, site_dir: 'build', git_branch: 'test_git_deploy', git_url: repo)
   Octopress::Deploy.push(config_file: config)
   Octopress::Deploy.pull(dir: 'pull-git', config_file: config)
-  diff_dir('_site', 'pull-git')
+  diff_dir('build', 'pull-git')
 end
 
 def test_local_git
@@ -85,9 +85,10 @@ def test_local_git
 
   # Test local git deployment
   #
-  Octopress::Deploy.push(config_file: config, git_url: File.expand_path(repo), remote_path: 'site')
+  Octopress::Deploy.init_config(method: 'git', config_file: config, force: true, site_dir: 'build', git_branch: 'test_git_deploy', git_url: File.expand_path(repo), remote_path: 'site')
+  Octopress::Deploy.push(config_file: config)
   Octopress::Deploy.pull(dir: 'pull-git', config_file: config, git_url: File.expand_path(repo), remote_path: 'site')
-  diff_dir('_site', 'pull-git/site')
+  diff_dir('build', 'pull-git/site')
 end
 
 def test_remote_rsync
@@ -99,10 +100,10 @@ def test_remote_rsync
   
   # Test remote git deployment
   #
-  Octopress::Deploy.init_config(method: 'rsync', config_file: config, force: true, user: 'imathis@imathis.com', remote_path: '~/octopress-deploy/rsync/')
+  Octopress::Deploy.init_config(method: 'rsync', config_file: config, site_dir: 'build', force: true, user: 'imathis@imathis.com', remote_path: '~/octopress-deploy/rsync/')
   Octopress::Deploy.push(config_file: config)
   Octopress::Deploy.pull(dir: 'pull-rsync', config_file: config)
-  diff_dir('_site', 'pull-rsync')
+  diff_dir('build', 'pull-rsync')
 
 end
 
@@ -115,10 +116,10 @@ def test_local_rsync
 
   # Test local git deployment
   #
-  Octopress::Deploy.init_config(method: 'rsync', config_file: config, force: true, remote_path: 'local-rsync')
+  Octopress::Deploy.init_config(method: 'rsync', config_file: config, site_dir: 'build', force: true, remote_path: 'local-rsync')
   Octopress::Deploy.push(config_file: config)
   Octopress::Deploy.pull(dir: 'pull-rsync', config_file: config, user: false, remote_path: 'local-rsync')
-  diff_dir('_site', 'pull-rsync')
+  diff_dir('build', 'pull-rsync')
 end
 
 def test_s3
@@ -127,7 +128,7 @@ def test_s3
   `rm -rf pull-s3`
   Octopress::Deploy.push(config_file: config)
   Octopress::Deploy.pull(dir: 'pull-s3', config_file: config)
-  diff_dir('_site', 'pull-s3')
+  diff_dir('build', 'pull-s3')
 end
 
 def print_test_results

metadata

@@ -1,83 +1,83 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc.5
+  version: 1.0.0.rc.6
 platform: ruby
 authors:
 - Brandon Mathis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octopress
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.rc.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.rc.1
 - !ruby/object:Gem::Dependency
   name: colorator
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: octopress-ink
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   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'
 description: Deploy Octopress and Jekyll sites easily
@@ -87,7 +87,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -122,17 +122,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - ">"
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Deploy Octopress and Jekyll sites easily