config_for 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 913db2240a68c47d331fd92b549f037e8e51e50a
-  data.tar.gz: ac3a6cb0e0491c7b0bbe1aa5abb076fa49d08665
+  metadata.gz: 4850c2ab8e9a71441f135fd051f6e881c60ca19e
+  data.tar.gz: 1acc6f6db0874c566c3320fc47a9a0e278bc4047
 SHA512:
-  metadata.gz: 98e1d460ae50bfee669183ffa146e4e9cadf3d26982dda1599e5d15f2eb875646cb37cfd132e87f467b13b961449bb409639ce03fb7366b314c23ac158ed4d17
-  data.tar.gz: b6bef0f6bc1ae0b202273367e209eac7e41f9816fff8699e7898730062c6fe631ae0e002bc28fa3e043bd20d7028091e9593661de86819638137ad7af3181c5c
+  metadata.gz: c4372aa9f7ed61367d6282037b440b0863658fb1b7c407dddf39a65b1f29de34077f0c27e36b00ab14252dd01fca6fb46c6b236b9e2d0b1c04a367d3ec0d98fb
+  data.tar.gz: 9af6528f541c9f88e467be6cb18a58aa89a60a09545e015b9970ee074d8c1b7de94485c2870301d26056425ce2d4fc4da896f0cc3ff4ca430693c141d203df66

data/lib/config_for/capistrano.rb

@@ -8,6 +8,78 @@ require 'yaml'
 module ConfigFor
   module Capistrano
 
+    class UploadFileTask < ::Rake::TaskLib
+
+      attr_reader :path, :tempfile
+
+      attr_accessor :generator
+      # Rake Task generator for uploading files through Capistrano
+      #
+      # @example generating task for config/unicorn.rb
+      #   ConfigFor::Capistrano::UploadFileTask.new('config/unicorn.rb', roles: :web) do |file|
+      #     file.write('some template')
+      #   end
+      #
+      #   Rake::Task['config/unicorn.rb'].invoke # uploads that file if it does not exist
+      # @param [Pathname, String] path the path of the file to be uploaded
+      # @param [Hash] options the options
+      # @option options [Array<Symbol>,Symbol] :roles (:all) the roles of servers to apply to
+      # @yieldparam [Tempfile] file yields the tempfile so you generate the file to be uploaded
+      def initialize(path, options = {}, &block)
+        @path = path
+        @roles = options.fetch(:roles, :all)
+        @tempfile = ::Tempfile.new(File.basename(@path))
+        @generator = block || ->(_file){ puts 'Did not passed file generator' }
+
+        define
+      end
+
+      private
+
+      include ::Capistrano::DSL
+
+      def define
+        desc "Upload file to #{path}"
+        remote_file(path => @tempfile.path, roles: @roles)
+        desc "Generate file #{@path} to temporary location"
+
+        generate_file(@tempfile.path, &method(:generate))
+      end
+
+      def generate(*)
+        @generator.call(@tempfile)
+        @tempfile.close(false)
+      end
+
+      # So it is always generated, because it is always needed
+      def generate_file(task, &block)
+        GenerateFileTask.define_task(task, &block)
+      end
+
+      # This reimplements Capistrano::DSL::TaskEnhancements#remote_file
+      # but uses UploadTask instead of Rake::Task
+
+      # TODO: can be removed when https://github.com/capistrano/capistrano/pull/1144
+      # is merged and released
+
+      def remote_file(task)
+        target_roles = task.delete(:roles)
+
+        UploadTask.define_task(task) do |t|
+          prerequisite_file = t.prerequisites.first
+          file = shared_path.join(t.name).to_s.shellescape
+
+          on roles(target_roles) do
+            unless test "[ -f #{file} ]"
+              info "Uploading #{prerequisite_file} to #{file}"
+              upload! File.open(prerequisite_file), file
+            end
+          end
+
+        end
+      end
+    end
+
     # inspired by https://github.com/rspec/rspec-core/blob/6b7f55e4fb36226cf830983aab8da8308f641708/lib/rspec/core/rake_task.rb
 
     # Rake Task generator for generating and uploading config files through Capistrano.
@@ -16,6 +88,10 @@ module ConfigFor
     # @example changing the folder
     #   ConfigFor::Capistrano::Task.new(:database) { |task| task.folder = 'configuration' }
     class Task < ::Rake::TaskLib
+      # @!attribute config
+      #   @return [ConfigFor::Capistrano::UploadFileTask] the task used to generate the config
+      attr_reader :config
+
       # @!attribute name
       #   @return [String] the name of the task and subtasks namespace
       attr_accessor :name
@@ -24,10 +100,6 @@ module ConfigFor
       #   @return [String] folder to upload the generated config
       attr_accessor :folder
 
-      # @!attribute tempfile
-      #   @return [Tempfile] temporary file for generating the config before upload
-      attr_accessor :tempfile
-
       # Generates new tasks with for uploading #name
       # @param [String, Symbol] name name of this tasks and subtasks
       # @param &block gets evaluated before defining the tasks
@@ -36,17 +108,18 @@ module ConfigFor
         @name = name
         @folder = 'config'
         @file = "#{name}.yml"
-        @roles = :all
-        @tempfile = ::Tempfile.new(@file)
         @variable = "#{name}_yml".to_sym
+        @roles = :all
 
         yield(self) if block_given?
 
+        @config = ConfigFor::Capistrano::UploadFileTask.new(path, roles: @roles, &method(:generate))
+
         desc "Generate #{name} uploader" unless ::Rake.application.last_comment
         define
       end
 
-      # Path where will be the file uploaded
+
       # Is a join of #folder and #file
       def path
         ::File.join(@folder, @file)
@@ -66,7 +139,7 @@ module ConfigFor
                         config.deep_stringify_keys
                       else
                         # TODO: remove when dropping rails 3 support
-                        # two level stringify for rails 3 compatability
+                        # two level stringify for rails 3 compatibility
                         config.stringify_keys.each_value(&:stringify_keys!)
                       end
         stringified.to_yaml
@@ -76,6 +149,10 @@ module ConfigFor
 
       include ::Capistrano::DSL
 
+      def generate(file)
+        file.write(yaml)
+      end
+
       def define
         namespace name do
           desc "Upload #{path} to remote servers"
@@ -100,47 +177,15 @@ module ConfigFor
 
           desc "Reset #{name} config"
           task reset: [:remove, :upload]
-
-          task :generate do
-            @tempfile.write(yaml)
-            @tempfile.close(false)
-          end
         end
 
-        remote_file path => @tempfile.path, roles: @roles
-        file @tempfile.path => "#{name}:generate"
-
         before 'deploy:check:linked_files', @name
 
         desc "Generate #{path}"
         task(name, &method(:run_task))
       end
-
-      # This reimplements Capistrano::DSL::TaskEnhancements#remote_file
-      # but uses UploadTask instead of Rake::Task
-
-      # TODO: can be removed when https://github.com/capistrano/capistrano/pull/1144
-      # is merged and released
-
-      def remote_file(task)
-        target_roles = task.delete(:roles)
-
-        UploadTask.define_task(task) do |t|
-          prerequisite_file = t.prerequisites.first
-          file = shared_path.join(t.name)
-
-          on roles(target_roles) do
-            unless test "[ -f #{file} ]"
-              info "Uploading #{prerequisite_file} to #{file}"
-              upload! File.open(prerequisite_file), file
-            end
-          end
-
-        end
-      end
     end
 
-
     private
 
     # Inheriting from Rake::FileCreationTask because it does not scope
@@ -152,5 +197,11 @@ module ConfigFor
         true
       end
     end
+
+    class GenerateFileTask < Rake::FileTask
+      def needed?
+        true
+      end
+    end
   end
 end

data/lib/config_for/config.rb

@@ -60,8 +60,9 @@ module ConfigFor
 
     def parse
       content = read
-      erb = ::ERB.new(content).result
-      ::YAML.load(erb, @pathname)
+      erb = ::ERB.new(content)
+      erb.filename = @pathname.to_s
+      ::YAML.load(erb.result, @pathname)
     rescue ::Psych::SyntaxError => e
       fail ConfigFor::InvalidConfigError, "YAML syntax error occurred while parsing #{content}. Error: #{e.message}"
     end

data/lib/config_for/version.rb

@@ -1,3 +1,3 @@
 module ConfigFor
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/spec/capistrano_spec.rb

@@ -1,20 +1,50 @@
 require 'config_for/capistrano'
 
-RSpec.describe ConfigFor::Capistrano do
-
-end
+module RspecSupport
+  def rake_task(task)
+    Rake::Task[task]
+  end
 
-RSpec.describe ConfigFor::Capistrano::Task do
   def invoke(task, *args)
     rake_task(task).invoke(*args)
   end
 
-  def rake_task(task)
-    Rake::Task[task]
+  def self.included(base)
+    base.before do
+      Rake.application = Rake::Application.new
+    end
   end
+end
+
+RSpec.describe ConfigFor::Capistrano do
+
+end
+
+RSpec.describe ConfigFor::Capistrano::UploadFileTask do
+  include RspecSupport
+
+  let!(:task_name) { self.class.description }
+  subject!(:task) { described_class.new(task_name) }
+
+  context 'config/unicorn.rb' do
+    context 'upload_task' do
+      subject(:upload_task) { rake_task(task.path) }
+      it { expect(upload_task.prerequisites).to eq([task.tempfile.path]) }
+    end
+
+    context 'file_task' do
+      subject(:file_task) { rake_task(task.tempfile.path) }
+
+      it { expect(file_task).to be }
+      it { expect(file_task).to be_needed }
+    end
+  end
+end
+
+RSpec.describe ConfigFor::Capistrano::Task do
+  include RspecSupport
 
   before do
-    Rake.application = Rake::Application.new
     Rake::Task.define_task('deploy:check:linked_files')
   end
 
@@ -35,14 +65,9 @@ RSpec.describe ConfigFor::Capistrano::Task do
 
     let(:prerequisites) { subject.prerequisites }
 
-    context 'tempfile' do
-      subject { rake_task(task.tempfile.path) }
-      it { expect(prerequisites).to eq(['database:generate']) }
-    end
-
     context 'remote_file' do
       subject { rake_task('config/database.yml') }
-      it { expect(prerequisites).to eq([task.tempfile.path]) }
+      it { is_expected.to be }
     end
 
     context 'upload' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: config_for
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Michal Cichra
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-06 00:00:00.000000000 Z
+date: 2014-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler