octopress-deploy 1.0.0.alpha.1 → 1.0.0.alpha.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10f414864560fd38076f95cf3ac0b16400794a6c
-  data.tar.gz: 5ee9dd24d6a7df9ffc0215377cbdc99562138c57
+  metadata.gz: 170e6e1991b426a98b1638fb45687b7016a9fc53
+  data.tar.gz: 9b9a154ac981bc45b2e01c7c46d171176f7f61de
 SHA512:
-  metadata.gz: c251e5f0f1ceb90e2a29964cd73f1ba9fea345512a839c0f61d39bcefa78bd522101cc47c843c0b8707dea95b65bcc9ccb0745f44343e294c4823b056af4b753
-  data.tar.gz: 332ec18880beaa38605ca0c362cf2a5290d315a7a869c0592f12dc23074af4574bb2e8f5b64509714d0cb15afe588c5ff8a81281006457769d1f6dc6c55cf4bc
+  metadata.gz: e6a9439fa388b44668239362ad0ccb3fab3cfb878a17f355f90bed8c5c92258fabd25321f81dcd06dc47bf0f89daf484b8b133ed7ed4f6b4c784c46878574641
+  data.tar.gz: 17df7f348642dbb83c89b563390fa1b2e8cd8ab778e5d0a9e36682e9ba5669d6fa21e1281928971339268e7d527f1b8da5dfaa787d6dfc5511e7c5e9d0cff0d9

data/README.md

@@ -1,6 +1,9 @@
 # Octopress Deploy
 
-Deployment tools for Octopress and Jekyll blogs.
+Deployment tools for Octopress and Jekyll blogs (or really any static site).
+
+Currently this supports deploying through Git and Rsync. Requests for other
+deployment methods are welcome.
 
 ## Installation
 
@@ -14,47 +17,61 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install octopress-deploy-git
-
-## Deploying with Git
-
-This is a generic git deployment system, it should work for GitHub, Heroku and other similar hosts.
-
-#### 1. Add a configuration file
+    $ gem install octopress-deploy
 
-Create a file named `_deploy.yml` in your project root.
+## Set up
 
-For GitHub user pages, the url should be something like: `git@github.com:username.github.io` and the branch should be master.
-For project pages, the url should be the path to the project repo and the branch should be `gh-pages`.
+To deploy your site run:
 
-```yml
-site: _site
-git:
-  url:
-  branch: master
+```ruby
+Octopress::Deploy.push()
 ```
 
-#### 2. From Ruby run
+This will read from your configuration file `_deploy.yml` and deploy your site. If your site has no configuration file, you will be asked if you want to generate one and what deployment method you want to use.
+
+You can also generate a configuration by running:
 
 ```ruby
-Octopress::Deploy::Git.new().push
+Octopress::Deploy.init_cofig('git') # or 'rsync'
 ```
 
-If you do not have a config file set up yet, this will offer to create a default one for you.
+This will generate a '_deploy.yml' file in your current directory.
 
-### Options
+### Configuration options
 
-It is recommended that you configure using the `deploy.yml`, but you can also pass configuration as options.
+Configurations should be added to a `_deploy.yml` file in your project's root directory. You can pass options as a hash directy to the `push` method as well. Passed options will override options set in the config file.
 
 | option        | Description                                      | Default
 |:--------------|:-------------------------------------------------|:---------------|
 | `config_file` | Path to the config file.                         | _config.yml    |
 | `site_dir`    | Path to comipled site files.                     | _site          |
+
+
+### Git options
+
+Only git_url is required. Other options will default as shown below.
+
+| option        | Description                                      | Default
+|:--------------|:-------------------------------------------------|:---------------|
 | `git_url`     | Url for remote git repository.                   |                |
 | `git_branch`  | Deployment branch for git repository.            | master         |
 | `deploy_dir`  | Directory where deployment files are staged.     | .deploy        |
 | `remote`      | Name of git remote.                              | deploy         |
 
+### Rsync options
+
+Only `remote_path` is required. If `user` is not present, Rsync will sync between two locally available directories. Do this if your site root is mounted locally.
+
+| option         | Description                                       | Default
+|:---------------|:--------------------------------------------------|:---------------|
+| `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`      | Inline list of rsync exclusions.                  |                |
+| `include`      | Inline list of inclusions to override exclusions. |                |
+| `delete`       | Delete files in destination not found in source   | false          |
+
 ## Contributing
 
 1. Fork it

data/lib/octopress-deploy/core_ext.rb

@@ -0,0 +1,45 @@
+class Hash
+  # Merges self with another hash, recursively.
+  #
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  #
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+      target[key] = hash[key]
+    end
+
+    target
+  end
+
+  def to_symbol_keys
+    inject({}) do |memo, (k, v)|
+      if v.is_a? Hash
+        memo[k.to_sym] = v.to_symbol_keys
+      else
+        memo[k.to_sym] = v
+      end
+
+      memo
+    end
+  end
+
+  def to_string_keys
+    inject({}) do |memo, (k, v)|
+      if v.is_a? Hash
+        memo[k.to_s] = v.to_string_keys
+      else
+        memo[k.to_s] = v
+      end
+
+      memo
+    end
+  end
+end
+

data/lib/octopress-deploy/git.rb

@@ -1,37 +1,15 @@
 module Octopress
   module Deploy
     class Git
-      def initialize(options={})
-        @config_file = options[:config_file] || '_deploy.yml'
-        if !File.exists? @config_file
-          init_config if ask_bool("Deployment config file not found. Create #{@config_file}?")         
-        else
-          config = YAML.load(File.open(@config_file))
-          @site_dir    = options[:site_dir]   || config['site']
-          @repo        = options[:git_url]    || config['git']['url']
-          @branch      = options[:git_branch] || config['git']['branch']
-          @deploy_dir  = options[:deploy_dir] || config['git']['deploy_dir'] || '.deploy'
-          @remote      = options[:remote]     || config['git']['remote'] || 'deploy'
-
-          abort "Deploy Failed: You must provide a repository URL before deploying. Check your #{@config_file}.".red if @repo.nil?
-        end
-      end
 
-      # Create a config file
-      #
-      def init_config
-        config = <<-FILE
-site: _site
-git:
-  url:
-  branch: master
-FILE
-        File.open(@config_file, 'w') { |f| f.write(config) }
-        puts "File #{@config_file} created.".green
-        puts "------------------"
-        puts config
-        puts "------------------"
-        puts "Please update it with your settings."
+      def initialize(options={})
+        @options    = options
+        @repo       = @options[:git_url]
+        @branch     = @options[:git_branch]
+        @site_dir   = @options[:site_dir]
+        @remote     = @options[:remote]     || 'deploy'
+        @deploy_dir = @options[:deploy_dir] || '.deploy'
+        abort "Deploy Failed: You must provide a repository URL before deploying. Check your #{@options[:config_file]}.".red if @repo.nil?
       end
 
       # Initialize, pull, copy and deploy.
@@ -53,6 +31,12 @@ FILE
         end
       end
 
+      def self.default_config(options={})
+        config = <<-CONFIG
+git_url: #{options[:git_url]}
+git_branch: #{options[:git_branch] || 'master'}
+CONFIG
+      end
 
       # If necessary create deploy directory and initialize it with deployment remote
       #
@@ -64,6 +48,7 @@ FILE
             # Attempt to clone from the remote
             #
             cmd = "git clone #{@repo} --origin #{@remote} --branch #{@branch} ."
+            puts cmd
             Open3.popen3(cmd) do |stdin, stdout, stderr, wait_thr|
               exit_status = wait_thr.value
 
@@ -102,30 +87,6 @@ FILE
           `git add --all :/; git commit -m '#{message}'`
         end
       end
-
-      def ask_bool(message)
-        ask(message, ['y','n']) == 'y'
-      end
-
-      def ask(message, valid_options)
-        if valid_options
-          options = valid_options.join '/'
-          answer = get_stdin("#{message} [#{options}]: ").downcase.strip
-          if valid_options.map{|o| o.downcase}.include?(answer)
-            return answer
-          else
-            return false
-          end
-        else
-          answer = get_stdin("#{message}: ")
-        end
-        answer
-      end
-            
-      def get_stdin(message)
-        print message
-        STDIN.gets.chomp
-      end
     end
   end
 end

data/lib/octopress-deploy/rsync.rb

@@ -0,0 +1,55 @@
+module Octopress
+  module Deploy
+    class Rsync
+
+      def initialize(options)
+        @user = options[:user]
+        @port = options[:port] || "22"
+        @local = options[:site_dir]
+        @remote = options[:remote_path]
+        @exclude = options[:exclude]
+        @exclude_file = options[:exclude_file]
+        @include = options[:include]
+        @delete  = options[:delete]
+      end
+
+      def push
+        cmd = "rsync -avz"
+        if @exclude || @exclude_file
+          cmd << "e"
+          if @exclude_file
+            cmd << " --exclude-from #{@exclude_file}"
+          else
+            cmd << " --exclude #{@exclude}"
+          end
+        end
+        if @include
+          cmd << " --include #{@include}"
+        end
+        if @user
+          cmd << " ssh -p #{@port}"
+        end
+        if @delete
+          cmd << " --delete"
+        end
+        cmd += " #{File.join(@local, '')} "
+        if @user
+          cmd << "#{@user}:"
+        end
+        cmd << "#{@remote}"
+
+        system cmd
+      end
+
+      def self.default_config(options={})
+        config = <<-CONFIG
+user: #{options[:user]}
+port: #{options[:port] || '22'}
+remote_path: #{options[:remote_path]}
+delete: #{options[:delete]}
+CONFIG
+      end
+      
+    end
+  end
+end

data/lib/octopress-deploy/version.rb

@@ -1,5 +1,5 @@
 module Octopress
   module Deploy
-    VERSION = "1.0.0.alpha.1"
+    VERSION = "1.0.0.alpha.2"
   end
 end

data/lib/octopress-deploy.rb

@@ -1,10 +1,103 @@
 require "octopress-deploy/version"
+require "octopress-deploy/core_ext"
 require "YAML"
 require 'colorator'
 require 'open3'
 
+
 module Octopress
   module Deploy
-    autoload :Git,  'octopress-deploy/git'
+    autoload :Git,    'octopress-deploy/git'
+    autoload :Rsync,  'octopress-deploy/rsync'
+
+    METHODS = {
+      'git'=> Git,
+      'rsync'=> Rsync
+    }
+
+    def self.push(options={})
+      init_options(options)
+      if !File.exists? @options[:config_file]
+        init_config if ask_bool("Deployment config file not found. Create #{@options[:config_file]}?")
+      else
+        parse_options
+        deploy_method.new(@options).push()
+      end
+    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)
+    end
+
+    def self.init_options(options={})
+      @options ||= options
+      @options[:config_file] ||= '_deploy.yml'
+      @options[:site_dir] ||= site_dir
+    end
+
+    def self.deploy_method
+      METHODS[@options[:method].downcase]
+    end
+
+    def self.site_dir
+      @options[:site_dir] || if File.exist? '_config.yml'
+        YAML.load(File.open('_config.yml'))['destination'] || '_site'
+      else
+        '_site'
+      end
+    end
+
+    # Create a config file
+    #
+    def self.init_config(method=nil, options={})
+      init_options unless @options
+      @options ||= options
+      @options[:method] ||= method
+      unless @options[:method]
+        @options[:method] = ask("How would you like to deploy your site?", METHODS.keys)
+      end
+      config = <<-FILE
+method: #{@options[:method]}
+site_dir: #{@options[:site_dir]}
+FILE
+      config += deploy_method.default_config(options)
+
+      if File.exist? @options[:config_file]
+        unless ask_bool("A config file already exists at #{@options[:config_file]}. Overwrite?")
+          abort "No config file written."
+        end
+      end
+      File.open(@options[:config_file], 'w') { |f| f.write(config) }
+      puts "File #{@options[:config_file]} created.".green
+      puts "------------------"
+      puts "#{config.yellow}------------------"
+      puts "Please add your configurations to this file."
+    end
+
+    def self.ask_bool(message)
+      ask(message, ['y','n']) == 'y'
+    end
+
+    def self.ask(message, valid_options)
+      if valid_options
+        options = valid_options.join '/'
+        answer = get_stdin("#{message} [#{options}]: ").downcase.strip
+        if valid_options.map{|o| o.downcase}.include?(answer)
+          return answer
+        else
+          return false
+        end
+      else
+        answer = get_stdin("#{message}: ")
+      end
+      answer
+    end
+          
+    def self.get_stdin(message)
+      print message
+      STDIN.gets.chomp
+    end
   end
 end

data/test/_deploy.yml

@@ -1,4 +1,4 @@
-site: _site
-git:
-  url: 
-  branch: master
+method: git
+site_dir: _site
+git_url: /Users/imathis/workspace/octodev/deploy/test/deploy_target
+git_branch: master

data/test/test.rb

@@ -1,9 +1,22 @@
 require 'octopress-deploy'
 
-FileUtils.mkdir 'deploy_target'
-FileUtils.cd 'deploy_target' do
-  system 'git init --bare'
+def test_git
+  FileUtils.mkdir 'deploy_target'
+  FileUtils.cd 'deploy_target' do
+    system 'git init --bare'
+  end
+  Octopress::Deploy.init_config('git', git_url: File.expand_path("deploy_target"))
+  Octopress::Deploy.push()
+  FileUtils.rm_r 'deploy_target'
 end
 
-Octopress::Deploy::Git.new({git_url: File.expand_path('deploy_target')}).push
-FileUtils.rm_r 'deploy_target'
+def test_rsync
+  FileUtils.mkdir_p "deploy-rsync"
+  Octopress::Deploy.init_config('rsync', remote_path: '.deploy')
+  Octopress::Deploy.push()
+  FileUtils.rm_r 'deploy-rsync'
+end
+
+test_git
+test_rsync
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress-deploy
 version: !ruby/object:Gem::Version
-  version: 1.0.0.alpha.1
+  version: 1.0.0.alpha.2
 platform: ruby
 authors:
 - Brandon Mathis
@@ -65,7 +65,9 @@ files:
 - README.md
 - Rakefile
 - lib/octopress-deploy.rb
+- lib/octopress-deploy/core_ext.rb
 - lib/octopress-deploy/git.rb
+- lib/octopress-deploy/rsync.rb
 - lib/octopress-deploy/version.rb
 - octopress-deploy.gemspec
 - test/Gemfile