statistrano 1.2.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 57e7b128b972ea3d1ef6479f4eff02bacd010969
-  data.tar.gz: 433092dffd702bc42225e8b120cebe5eec7f26f0
+  metadata.gz: 687953197199b61ff409d6d2ca46af228ddd046b
+  data.tar.gz: 8ac0ee0ec0b9637728ca792c6e2b6301bd963acc
 SHA512:
-  metadata.gz: e8da835126fc8f176e186dd0e503ce3c39379866257db1a9fffdb965a0232b941ae05e148b37ea60e65691c0375f1bbd9e0e3eccb6c89717661fe483ad833e63
-  data.tar.gz: 4e29ddaee9c5f1522664e0458472f6c9b511193467520dd774bf8bce4e7f9217836c34024ecf8083984ee118d962a2730c2df3a620774a0ef6eebfd660da1f61
+  metadata.gz: ef1939faf699e13754e73d363725f4f8fb9ad448c022e88f4a11c98cb9041f00414f960422426342da392309774385fac921691e19027054e07a38119ae0ba89
+  data.tar.gz: bbd659c40f1589b2d7ff3c497f73052c1dc452158309df8b7e73385e8d754a7b0e789ceaa152c1449d8f166ac99e53474b8f6c85e2bdb4728f1a92b9a6a50e45

data/changelog.md

@@ -1,3 +1,13 @@
+# 1.3.0
+- feat(config validation) setup validators for some optons that could be descructive if not set:
+  ```
+  Base: remote_dir
+  Branches: public_dir
+  Releases: release_count, public_dir, releases_dir
+  ```
+- refactor(config) change the internal method signature of Config to use keyword arguments `options`, and `tasks`
+- add a `run_local` method to Remote to wrap `Shell.run_local` to display commands when in verbose mode.
+
 # 1.2.3
 - fix bug in manifest creation/saving from changes in ruby 2.2.x
 

data/lib/statistrano/config.rb

@@ -5,23 +5,42 @@ module Statistrano
   class Config
     include RakeTaskWithContextCreation
 
-    attr_reader :options
-    attr_reader :tasks
+    attr_reader :options,
+                :tasks,
+                :validators
 
     # initalize with the potential for seed options
     # this is required so that when config'd classes
     # are extended we can pass that configuration along
-    def initialize options=nil, tasks=nil
-      @options = options.nil? ? {} : options.clone
-      @tasks   = tasks.nil?   ? {} : tasks.clone
+    def initialize options: nil, tasks: nil, validators: nil
+      @options    = options.nil?    ? {} : options.clone
+      @tasks      = tasks.nil?      ? {} : tasks.clone
+      @validators = validators.nil? ? {} : validators.clone
 
       @options.each do |key,val|
         define_option_accessor key.to_sym
       end
+
+      @validators.each do |key,val|
+        define_validator key.to_sym
+      end
     end
 
     private
 
+      def define_validator name
+        define_singleton_method(:"validator_for_#{name}") do |proc, message|
+          @validators[name] = { validator: proc,
+                                message: message }
+        end
+
+        define_singleton_method(:"validate_#{name}") do |arg|
+          if @validators.has_key?(name) && !@validators[name][:validator].call(arg)
+            raise ValidationError, (@validators[name][:message] || "configuration option for '#{name}' failed it's validation")
+          end
+        end
+      end
+
       def define_option_accessor name
         define_singleton_method(name) do |*args, &block|
           if block
@@ -34,13 +53,22 @@ module Statistrano
           end
 
           if args.length == 1
-            @options[name] = args[0]
+            val = args[0]
+
+            if @validators.has_key?(name)
+              val = val.call if val.respond_to?(:call)
+              send "validate_#{name}", val
+            end
+
+            @options[name] = val
           elsif args.empty?
             if @options[name].respond_to? :fetch
-              @options[name].fetch( :call, -> { @options[name] } ).call
+              opt = @options[name].fetch( :call, -> { @options[name] } ).call
             else
-              @options[name]
+              opt = @options[name]
             end
+
+            opt
           else
             raise ArgumentError, "wrong number of arguments (#{args.length} for 0..1)"
           end
@@ -48,5 +76,8 @@ module Statistrano
         define_singleton_method("#{name}=") { |arg| @options[name] = arg }
       end
 
+      class ValidationError < StandardError
+      end
+
   end
 end

data/lib/statistrano/config/configurable.rb

@@ -6,7 +6,7 @@ module Statistrano
         @_configuration ||= Config.new()
       end
 
-      def option key, value=nil, proc=nil
+      def option key, value=nil, proc=nil, opts={}
         if proc
           configuration.options[key] = { call: proc }
         else
@@ -14,6 +14,13 @@ module Statistrano
         end
       end
 
+      def validate key, proc, message=nil
+        configuration.validators[key] = { validator: proc }
+        if message
+          configuration.validators[key][:message] = message
+        end
+      end
+
       def options *args
         args.each { |a| option(a) }
       end
@@ -32,8 +39,9 @@ module Statistrano
         extending_obj.send :define_method,
                            :config,
                            -> {
-                              @_config ||= Config.new( self.class.configuration.options,
-                                                       self.class.configuration.tasks )
+                              @_config ||= Config.new( options: self.class.configuration.options,
+                                                       tasks: self.class.configuration.tasks,
+                                                       validators: self.class.configuration.validators )
                            }
       end
 
@@ -45,9 +53,10 @@ module Statistrano
         subclass.superclass.class_eval do
           subclass.configuration.options.merge!  subclass.superclass.configuration.options
           subclass.configuration.tasks.merge! subclass.superclass.configuration.tasks
+          subclass.configuration.validators.merge! subclass.superclass.configuration.validators
         end
       end
 
     end
   end
-end
+end

data/lib/statistrano/deployment/strategy/base.rb

@@ -29,6 +29,9 @@ module Statistrano
 
         option  :verbose, false
 
+        validate :remote_dir, lambda { |d| !d.empty? && d != '/' },
+                 "'remote_dir' must not be empty or '/'"
+
         task :deploy,      :deploy,                  "Deploy to remote"
         task :build,       :invoke_build_task,       "Run build task"
         task :post_deploy, :invoke_post_deploy_task, "Run post deploy task"
@@ -84,7 +87,7 @@ module Statistrano
           return @_remotes if @_remotes
 
           @_remotes = config.options[:remotes].map do |remote_options|
-            Remote.new Config.new( config.options.dup.merge(remote_options) )
+            Remote.new Config.new( options: config.options.dup.merge(remote_options) )
           end
           @_remotes.push Remote.new(config) if @_remotes.empty?
 

data/lib/statistrano/deployment/strategy/branches.rb

@@ -16,11 +16,15 @@ module Statistrano
           d.generate_index
         }
 
+        validate :public_dir, lambda { |d| !d.to_s.empty? && d != '/' },
+                 "'public_dir' can't be an empty string or '/'"
+
         task :list,           :list_releases,  "List branches"
         task :prune,          :prune_releases, "Prune a branch"
         task :generate_index, :generate_index, "Generate a branch index"
         task :open,           :open_url,       "Open the current branch URL"
 
+
         # output a list of the releases in manifest
         # @return [Void]
         def list_releases

data/lib/statistrano/deployment/strategy/releases.rb

@@ -35,6 +35,15 @@ module Statistrano
 
         option :remotes, []
 
+        validate :release_dir, lambda { |d| !d.to_s.empty? && d != '/' },
+                 "'release_dir' can't be an empty string or '/'"
+
+        validate :public_dir, lambda { |d| !d.to_s.empty? && d != '/' },
+                 "'public_dir' can't be an empty string or '/'"
+
+        validate :release_count, lambda { |c| c.is_a?(Integer) && c > 0 },
+                 "'release_count' must be an integer greater than 0"
+
         task :deploy,   :deploy,           "Deploy to all remotes"
         task :rollback, :rollback_release, "Rollback to the previous release"
         task :prune,    :prune_releases,   "Prune releases to release count"

data/lib/statistrano/remote.rb

@@ -38,6 +38,14 @@ module Statistrano
       session.run command
     end
 
+    def run_local command
+      if config.verbose
+        Log.info :local, "running cmd: #{command}"
+      end
+
+      Shell.run_local command
+    end
+
     def done
       session.close_session
     end
@@ -63,9 +71,9 @@ module Statistrano
       Log.info "Syncing files from '#{local_path}' to '#{remote_path}' on #{config.hostname}"
 
       time_before = Time.now
-      resp = Shell.run_local "rsync #{rsync_options} " +
-                             "-e ssh #{local_path}/ " +
-                             "#{host_connection}:#{remote_path}/"
+      resp = run_local "rsync #{rsync_options} " +
+                       "-e ssh #{local_path}/ " +
+                       "#{host_connection}:#{remote_path}/"
       time_after = Time.now
       total_time = (time_after - time_before).round(2)
 

data/lib/statistrano/shell.rb

@@ -14,4 +14,4 @@ module Statistrano
     end
 
   end
-end
+end

data/lib/statistrano/version.rb

@@ -1,3 +1,3 @@
 module Statistrano
-  VERSION = "1.2.3"
+  VERSION = "1.3.0"
 end

data/spec/lib/statistrano/config/configurable_spec.rb

@@ -11,6 +11,9 @@ describe Statistrano::Config::Configurable do
       option :proc, -> { "hello" }
 
       options :one, :two
+
+      validate :three, lambda { |arg| arg }
+      validate :four, lambda { |arg| arg }, "didn't pass"
     end
   end
 
@@ -47,6 +50,16 @@ describe Statistrano::Config::Configurable do
     end
   end
 
+  describe "#validate" do
+    it "adds valiator to configuration.validators" do
+      expect( subject.config.validators.keys ).to include :three
+    end
+
+    it "adds validator with description if given" do
+      expect( subject.config.validators[:four][:message] ).to eq "didn't pass"
+    end
+  end
+
   describe "option accessor" do
     let(:config) { subject.config }
 
@@ -85,4 +98,4 @@ describe Statistrano::Config::Configurable do
   end
 
 
-end
+end

data/spec/lib/statistrano/config_spec.rb

@@ -3,31 +3,80 @@ require 'spec_helper'
 describe Statistrano::Config do
 
   describe "#initialize" do
-    it "defaults options & tasks to a blank hash" do
+    it "defaults options, tasks, & validators to a blank hash" do
       subject = described_class.new
 
       expect( subject.options ).to eq({})
       expect( subject.tasks ).to eq({})
+      expect( subject.validators ).to eq({})
     end
 
     it "defines an accessor for each given option" do
-      subject = described_class.new foo: 'bar'
+      subject = described_class.new options: { foo: 'bar' }
       expect( subject.foo ).to eq 'bar'
     end
 
-    it "uses given options & tasks, but clones so the originals don't get modified" do
-      options = { foo: 'bar' }
-      tasks   = { foo: 'bar' }
-      subject = described_class.new options, tasks
+    it "uses given options, tasks, and validators, but clones so the originals don't get modified" do
+      options    = { foo: 'bar' }
+      tasks      = { foo: 'bar' }
+      validators = { foo: { validator: lambda { |arg| arg } } }
 
-      subject.foo         = 'baz'
-      subject.tasks[:foo] = 'baz'
+      subject = described_class.new options: options, tasks: tasks, validators: validators
+
+      subject.foo              = 'baz'
+      subject.tasks[:foo]      = 'baz'
+      subject.validators[:foo] = { validator: lambda { |arg| 'baz' } }
 
       expect( subject.foo ).to eq 'baz'
       expect( options ).to eq foo: 'bar'
 
       expect( subject.tasks ).to eq foo: 'baz'
       expect( tasks ).to eq foo: 'bar'
+
+      expect( subject.validators[:foo][:validator].call('arg') ).to eq 'baz'
+      expect( validators[:foo][:validator].call('arg') ).to eq 'arg'
+    end
+  end
+
+  describe "#accessor set" do
+    context "when a validator is set" do
+      let(:subject) do
+        subject = described_class.new options: { string: '', integer: '' },
+                                      validators: {
+                                        string: { validator: lambda { |i| !i.to_s.empty? } },
+                                        integer: { validator: lambda { |i| i.is_a?(Integer) } }
+                                      }
+
+        subject.validators[:integer][:message] = "not an integer"
+
+        subject
+      end
+
+      it "is peachy with a valid value" do
+        expect{
+          subject.validate_string 'a string'
+        }.not_to raise_error
+      end
+
+      it "raises when validating invalid value" do
+        expect{
+          subject.validate_string ''
+        }.to raise_error Statistrano::Config::ValidationError
+      end
+
+      it "raises while validating with given message" do
+        expect{
+          subject.validate_integer 'foobar'
+        }.to raise_error Statistrano::Config::ValidationError, 'not an integer'
+      end
+
+      it "raises when set to invalid value" do
+        expect{
+          subject.integer 'foo'
+        }.to raise_error Statistrano::Config::ValidationError
+      end
+
+
     end
   end
 

data/spec/lib/statistrano/deployment/strategy/base_spec.rb

@@ -13,6 +13,22 @@ describe Statistrano::Deployment::Strategy::Base do
     end
   end
 
+  describe "config validation" do
+    it "doesn't allow remote_dir to be empty" do
+      subject = described_class.new "hello"
+      expect{
+        subject.config.remote_dir ""
+      }.to raise_error Statistrano::Config::ValidationError
+    end
+
+    it "doesn't allow you to set remote_dir as /" do
+      subject = described_class.new "hello"
+      expect{
+        subject.config.remote_dir "/"
+      }.to raise_error Statistrano::Config::ValidationError
+    end
+  end
+
   describe "#deploy" do
 
     before :each do

data/spec/lib/statistrano/deployment/strategy/branches_spec.rb

@@ -16,4 +16,16 @@ describe Statistrano::Deployment::Strategy::Branches do
     end
   end
 
-end
+  it "validates public_dir not empty or '/'" do
+    deployment = described_class.new("name")
+
+    expect{
+      deployment.config.public_dir ""
+    }.to raise_error Statistrano::Config::ValidationError
+
+    expect{
+      deployment.config.public_dir "/"
+    }.to raise_error Statistrano::Config::ValidationError
+  end
+
+end

data/spec/lib/statistrano/deployment/strategy/releases_spec.rb

@@ -6,6 +6,38 @@ describe Statistrano::Deployment::Strategy::Releases do
     expect( Statistrano::Deployment::Strategy.find(:releases) ).to eq described_class
   end
 
+  describe "config validation" do
+    let(:subject) { described_class.new('hello') }
+
+    it "prevents release_dir from being empty or '/'" do
+      expect{
+        subject.config.release_dir ''
+      }.to raise_error Statistrano::Config::ValidationError
+
+      expect{
+        subject.config.release_dir '/'
+      }.to raise_error Statistrano::Config::ValidationError
+    end
+    it "prevents public_dir from being empty or '/'" do
+      expect{
+        subject.config.public_dir ''
+      }.to raise_error Statistrano::Config::ValidationError
+
+      expect{
+        subject.config.public_dir '/'
+      }.to raise_error Statistrano::Config::ValidationError
+    end
+    it "requires release_count to be an integer > 0" do
+      expect{
+        subject.config.release_count 'four'
+      }.to raise_error Statistrano::Config::ValidationError
+
+      expect{
+        subject.config.release_count 0
+      }.to raise_error Statistrano::Config::ValidationError
+    end
+  end
+
   describe "#remotes" do
 
     let(:default_options) do
@@ -73,8 +105,8 @@ describe Statistrano::Deployment::Strategy::Releases do
 
       config_double = instance_double("Statistrano::Config")
       expect( Statistrano::Config ).to receive(:new)
-                                   .with(default_options.merge({remotes: [{hostname: 'web01', remote_dir: 'web01_remote_dir'}]})
-                                                        .merge(hostname: 'web01', remote_dir: 'web01_remote_dir'))
+                                   .with( options: default_options.merge({remotes: [{hostname: 'web01', remote_dir: 'web01_remote_dir'}]})
+                                                                  .merge(hostname: 'web01', remote_dir: 'web01_remote_dir'))
                                    .and_return(config_double)
       expect( Statistrano::Remote ).to receive(:new)
                                    .with(config_double)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: statistrano
 version: !ruby/object:Gem::Version
-  version: 1.2.3
+  version: 1.3.0
 platform: ruby
 authors:
 - Jordan Andree
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-17 00:00:00.000000000 Z
+date: 2015-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -184,7 +184,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: deployment tool for static sites