apache-config-generator 0.2.6 → 0.2.7

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    apache-config-generator (0.2.6)
+    apache-config-generator (0.2.7)
       rainbow
 
 GEM
@@ -9,7 +9,7 @@ GEM
   specs:
     autotest (4.4.2)
     diff-lcs (1.1.2)
-    mocha (0.9.9)
+    mocha (0.9.10)
       rake
     nokogiri (1.4.3.1)
     rainbow (1.1)

data/README.rdoc

@@ -2,6 +2,8 @@
 
 Programmatically construct your Apache configuration using a powerful DSL built in Ruby.
 
+As of version 0.2.7, your destination config directory is destroyed and re-created each time the apache:create Rake task is run.
+
 == Installation
 
 <tt>gem install apache-config-generator</tt>
@@ -92,6 +94,8 @@ The above config is transformed into the following:
   RewriteCond "%{HTTP_REFERER}" "^!my-cool-website\.cool\.wow"
   RewriteRule "\.(gif|jpg|png|pdf)$" "/lol-image-stealer.html" [L,R]
 
+The destination configs directory is destroyed and re-created each time the apache:create Rake task is run.
+
 == Using Apache::Config separately
 
 Include the gem and access the methods on Apache::Config directly. See test/example_standalone.rb

data/Rakefile

@@ -20,3 +20,9 @@ end
 task :reek do
   system('reek -c config/config.reek lib/*')
 end
+
+task :gem do
+  system %{rm *.gem}
+  system %{gem build apache-config-generator.gemspec}
+  system %{gem install apache-config-generator-*.gem}
+end

data/autotest/discover.rb

@@ -1 +1,6 @@
 Autotest.add_discovery { "rspec2" }
+
+Autotest.add_hook(:initialize) do |at|
+  at.add_exception(%r{^./test/.*})
+end
+  

data/bin/apache-configurator

@@ -1,17 +1,29 @@
 #!/usr/bin/env ruby
 
 require 'fileutils'
+require 'rubygems'
+require 'rainbow'
 
 if !ARGV[0]
-	puts "Directory name required."
+	puts "Directory name required.".foreground(:red)
 	exit 1
 end
 
 if File.directory?(ARGV[0])
-	puts "You can't overwrite an existing directory."
+	puts "You can't overwrite an existing directory.".foreground(:red)
 	exit 1
 end
 
+puts "Copying skel files...".foreground(:green)
 FileUtils.cp_r File.expand_path(File.join(File.dirname(__FILE__), '..', 'skel')), ARGV[0]
+
+puts "Making config directories...".foreground(:green)
 FileUtils.mkdir_p File.join(ARGV[0], 'source')
+FileUtils.mkdir_p File.join(ARGV[0], 'conf.d-original')
 FileUtils.mkdir_p File.join(ARGV[0], 'conf.d')
+
+print "Complete! ".bright.foreground(:green)
+print "cd #{ARGV[0]}".bright.foreground(:yellow)
+print " and run ".foreground(:green)
+print "bundle exec rake -T ".bright.foreground(:yellow)
+puts "to get started.".foreground(:green)

data/lib/apache/config.rb

@@ -92,16 +92,38 @@ module Apache
       def build(target, &block)
         config = build_and_return(&block)
 
-        FileUtils.mkdir_p File.split(target).first
-        File.open(target, 'w') { |file| file.puts [ "# Generated by apache-config-generator #{Time.now.to_s}", config ].flatten * "\n" }
+        if !disabled?
+          FileUtils.mkdir_p File.split(target).first
+          File.open(target, 'w') { |file| file.puts generate_config_file(config) * "\n" }
+          @was_written = true
+        end
 
         config
       end
 
+      # If included in a configuration, will not generate the config file in the Rake task
+      def disable!
+        @is_disabled = true
+      end
+
+      def disabled?
+        @is_disabled
+      end
+
+      def written?
+        @was_written
+      end
+
+      def generate_config_file(config)
+        [ "# Generated by apache-config-generator #{Time.now.to_s}", config ].flatten
+      end
+
       # Reset the current settings
       def reset!
         @config = []
         @line_indent = 0
+        @is_disabled = false
+        @was_written = false
       end
 
       # Indent the string by the current @line_indent level

data/lib/apache/hash.rb

@@ -0,0 +1,8 @@
+class Hash
+  def to_sym_keys
+    Hash[self.collect { |key, value|
+      value = value.to_sym_keys if value.kind_of?(Hash)
+      [ key.to_sym, value ]
+    }]
+  end
+end

data/lib/apache/rake/apache/create.rb

@@ -5,6 +5,15 @@ include Apache::Rake::Support
 
 task :default => 'apache:create'
 
+def capture_stdout
+  buffer = StringIO.new
+  $stdout = buffer
+  yield
+  $stdout = STDOUT
+  buffer.rewind
+  buffer.read
+end
+
 namespace :apache do
   desc "Create all defined configs for the specified environment"
   task :create, :environment do |t, args|
@@ -16,20 +25,28 @@ namespace :apache do
       APACHE_ENV = (args[:environment] || get_default_environment).to_sym
     end
 
-    config[:source_path] = File.expand_path(config[:source])
-    config[:dest_path] = File.expand_path(config[:destination])
-
     Apache::Config.rotate_logs_path = config[:rotate_logs_path]
 
-    FileUtils.mkdir_p config[:dest_path]
-    Dir.chdir config[:dest_path]
+    FileUtils.rm_rf config[:destination_path]
+    FileUtils.mkdir_p config[:destination_path]
+    Dir.chdir config[:destination_path]
 
-    # using CONFIG is deprecated
     CONFIG = config
 
+    ENVIRONMENT_CONFIG = (config[:environments][APACHE_ENV] rescue nil)
+
     Dir[File.join(config[:source_path], '**', '*.rb')].each do |file|
-      puts file.foreground(:green)
-      require file
+      Apache::Config.reset!
+      output = capture_stdout { require file }
+
+      if Apache::Config.written?
+        if Apache::Config.disabled?
+          puts file.foreground(:blue)
+        else
+          puts file.foreground(:green)
+        end
+        puts output
+      end
     end
   end
 

data/lib/apache/rake/support.rb

@@ -1,16 +1,44 @@
 require 'yaml'
 require 'fileutils'
+require 'apache/hash'
 
 module Apache
   module Rake
     module Support
       def config
-        @config ||= Hash[YAML.load_file('config.yml').collect { |k,v| [ k.to_sym, v ] }]
+        if !@config
+          @config = YAML.load_file('config.yml').to_sym_keys
+          config_paths!
+
+          class << @config
+            def [](which)
+              if which == :dest_path
+                print "config[:dest_path] is deprecated.".foreground(:red).bright
+                puts  " Use config[:destination_path] instead.".foreground(:red)
+
+                self[:destination_path]
+              else
+                super
+              end
+            end
+          end
+        end
+
+        @config
       end
 
-      def get_environments
-        config[:source_path] = File.expand_path(config[:source])
+      def config_paths!
+        [ :source, :destination ].each do |which|
+          begin
+            @config[:"#{which}_path"] = File.expand_path(@config[which])
+          rescue StandardError
+            puts "#{which.to_s.bright} is not defined in the configuration file.".foreground(:red)
+            exit 1
+          end
+        end
+      end
 
+      def get_environments
         Dir[File.join(config[:source_path], '**', '*.rb')].collect { |file|
           File.readlines(file).find_all { |line| line[%r{(if_environment|build_if)}] }.collect { |line| line.scan(%r{:[a-z_]+}) }
         }.flatten.uniq.sort.collect { |name| name[1..-1] }

data/lib/apache/version.rb

@@ -1,3 +1,3 @@
 module Apache
-  VERSION = '0.2.6'
+  VERSION = '0.2.7'
 end

data/skel/Gemfile

@@ -1,2 +1,5 @@
 source :rubygems
-gem 'apache-config-generator'
+
+gem 'apache-config-generator', '>= 0.2.7'
+gem 'rake'
+

data/skel/Rakefile

@@ -1,3 +1 @@
-require 'rubygems'
-
-require 'apache/rake/create'
+require 'apache/rake/apache/create'

data/spec/apache/config_spec.rb

@@ -33,6 +33,40 @@ describe Apache::Config, "builds configurations" do
     end
   end
 
+  describe '.disable!' do
+    context 'is enabled by default' do
+      it { apache.instance_variable_get(:@is_disabled).should be_false }
+      it { apache.disabled?.should be_false }
+
+      context 'writes config' do
+        before {
+          FileUtils.expects(:mkdir_p).once
+          File.expects(:open).once
+          apache.build("here") { cats }
+        }
+
+        it { apache.written?.should == true }
+      end
+    end
+
+    context 'disable' do
+      before { apache.disable! }
+
+      it { apache.instance_variable_get(:@is_disabled).should be_true }
+      it { apache.disabled?.should be_true }
+
+      context 'does not write config' do
+        before {
+          FileUtils.expects(:mkdir_p).never
+          File.expects(:open).never
+          apache.build("here") { disable!; cats }
+        }
+
+        it { apache.written?.should == false }
+      end
+    end
+  end
+
   it "should handle indent" do
     apache.line_indent = 1
 
@@ -84,9 +118,13 @@ describe Apache::Config, "builds configurations" do
   end
 
   it "should handle a build" do
+    apache.written?.should be_false
+
     FileUtils.mkdir_p 'test'
     apache.build('test/fake.conf') { my_test "this" }.should == [ 'MyTest "this"' ]
     FileUtils.rm 'test/fake.conf'
+
+    apache.written?.should be_true
   end
 
   it "should handle building if the environment is correct" do

data/spec/apache/hash_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'lib/apache/hash'
+
+describe Hash do
+  describe '#to_sym_keys' do
+    subject { test_hash.to_sym_keys }
+
+    context 'no nested hashes' do
+      let(:test_hash) { {
+        'hello' => 'goodbye',
+        :other => 'this'
+      } }
+
+      it { should == {
+        :hello => 'goodbye',
+        :other => 'this'
+      } }
+    end
+
+    context 'nested hash' do
+      let(:test_hash) { {
+        'hello' => 'goodbye',
+        :other => {
+          'this' => 'that'
+        }
+      } }
+
+      it { should == {
+        :hello => 'goodbye',
+        :other => {
+          :this => 'that'
+        }
+      } }
+    end
+  end
+end

data/spec/apache/rake/support_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+require 'apache/rake/support'
+
+describe Apache::Rake::Support do
+  include Apache::Rake::Support
+
+  let(:source) { '/source' }
+  let(:destination) { '/destination/available' }
+
+  describe 'config_paths!' do
+    before {
+      @config = {
+        :source => 'cats',
+        :destination => 'dogs'
+      }
+    }
+
+    subject { config_paths!; @config }
+
+    its([:source_path]) { should == File.expand_path('cats') }
+    its([:destination_path]) { should == File.expand_path('dogs') }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+Rspec.configure do |config|
+  config.mock_with :mocha
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: apache-config-generator
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 7
+  version: 0.2.7
 platform: ruby
 authors: 
 - John Bintz
@@ -15,13 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-29 00:00:00 -05:00
+date: 2011-01-06 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: bundler
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -32,12 +30,12 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  requirement: *id001
+  name: bundler
+  prerelease: false
   type: :development
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -48,12 +46,12 @@ dependencies:
         - 0
         - 0
         version: 2.0.0
+  requirement: *id002
+  name: rspec
+  prerelease: false
   type: :development
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: nokogiri
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -62,12 +60,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id003
+  name: nokogiri
+  prerelease: false
   type: :development
-  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -76,12 +74,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id004
+  name: mocha
+  prerelease: false
   type: :development
-  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: autotest
-  prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -90,12 +88,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id005
+  name: autotest
+  prerelease: false
   type: :development
-  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: reek
-  prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -104,12 +102,12 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id006
+  name: reek
+  prerelease: false
   type: :development
-  version_requirements: *id006
 - !ruby/object:Gem::Dependency 
-  name: rainbow
-  prerelease: false
-  requirement: &id007 !ruby/object:Gem::Requirement 
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -118,8 +116,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  requirement: *id007
+  name: rainbow
+  prerelease: false
   type: :runtime
-  version_requirements: *id007
 description: A Ruby DSL for programmatically generating Apache configs
 email: john@coswellproductions.com
 executables: 
@@ -142,6 +142,7 @@ files:
 - lib/apache/apachify.rb
 - lib/apache/config.rb
 - lib/apache/directory.rb
+- lib/apache/hash.rb
 - lib/apache/logging.rb
 - lib/apache/master.rb
 - lib/apache/modules.rb
@@ -160,12 +161,14 @@ files:
 - spec/apache/apachify_spec.rb
 - spec/apache/config_spec.rb
 - spec/apache/directory_spec.rb
+- spec/apache/hash_spec.rb
 - spec/apache/logging_spec.rb
 - spec/apache/master_spec.rb
 - spec/apache/modules_spec.rb
 - spec/apache/mpm_prefork_spec.rb
 - spec/apache/performance_spec.rb
 - spec/apache/permissions_spec.rb
+- spec/apache/rake/support_spec.rb
 - spec/apache/rewrites_spec.rb
 - spec/spec_helper.rb
 - test/config/httpd.rb