shellac 0.0.2.1 → 0.0.2.3

data/.gitignore

@@ -0,0 +1,58 @@
+# Rails
+.bundle
+db/*.sqlite3
+db/*.sqlite3-journal
+*.log
+tmp
+tmp/**/*
+public
+config/database.yml
+db/schema.rb
+Gemfile.lock
+
+# Vendor Cache
+vendor/cache
+
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+*.gem
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+.DS_Store
+#
+# For Text
+*.tmproj
+tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/Rakefile

@@ -1,53 +1,5 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "shellac"
-  gem.homepage = "http://github.com/bitflut/shellac"
-  gem.license = "MIT"
-  gem.summary = %Q{Shellac is a gem to easily send purges to varnish servers from rails}
-  gem.description = %Q{Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem}
-  gem.email = "marian@bitflut.com"
-  gem.authors = ["Marian"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  gem.add_runtime_dependency 'klarlack', '~> 0.0.6'
-  #  gem.add_development_dependency 'rspec', '> 1.2.3'
-end
-Jeweler::RubygemsDotOrgTasks.new
-
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
+require File.expand_path('../config/application', __FILE__)
+ShellacApp::Application.load_tasks
 
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "shellac #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/generators/shellac/install_generator.rb

@@ -3,9 +3,11 @@ require 'rails/generators'
 module Shellac
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      
+      source_root File.expand_path("../../templates", __FILE__)
             
       def generate
-        copy_file "../templates/varnish.yml", "config/varnish.yml"
+        copy_file "config/varnish.yml", "config/varnish.yml"
         
         puts "------------------------"
         puts "Now configure your varnish setup here:"

data/lib/shellac.rb

@@ -2,15 +2,13 @@ require 'rails'
 require 'klarlack'
 
 class Railtie < Rails::Railtie
-  
   config.before_initialize do
     require File.expand_path('../shellac/cache', __FILE__)
     require File.expand_path('../shellac/actions', __FILE__)
   end
-  
+
   config.to_prepare do
     ActionController::Base.send :extend, Shellac::Actions
     ActionController::Base.send :include, Shellac::Actions
   end
-
 end

data/lib/shellac/actions.rb

@@ -2,7 +2,7 @@ module Shellac
   module Actions
   
     def purge regex, recursive=false
-      return unless perform_caching
+      return unless ActionController::Base.perform_caching
       Shellac::Cache.instance.purge regex, recursive
     end
   

data/lib/shellac/cache.rb

@@ -1,8 +1,12 @@
+require 'singleton'
+
 module Shellac
   class Cache
     include Singleton
     
-    VARNISH_CONFIGURATION = YAML.load_file("#{Rails.root.to_s}/config/varnish.yml")[::Rails.env]    
+    if File.exist?("#{File.expand_path(Rails.root.to_s)}/config/varnish.yml")
+      VARNISH_CONFIGURATION = YAML.load_file("#{Rails.root.to_s}/config/varnish.yml")[::Rails.env]
+    end
     
     # return client instance
     def client
@@ -30,7 +34,11 @@ module Shellac
     protected
     
       def config attr
-        VARNISH_CONFIGURATION[attr]
+        begin
+          VARNISH_CONFIGURATION[attr]
+        rescue
+          raise "Shellac was not properly configured for #{::Rails.env} environment. Did you run rails generate shellac:install?"
+        end
       end
   end
 end

data/shellac.gemspec

@@ -1,74 +1,49 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'shellac/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{shellac}
-  s.version = "0.0.2.1"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Marian"]
-  s.date = %q{2011-04-12}
-  s.description = %q{Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem}
-  s.email = %q{marian@bitflut.com}
-  s.extra_rdoc_files = [
-    "LICENSE.txt",
-    "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-    "Gemfile",
-    "Gemfile.lock",
-    "LICENSE.txt",
-    "README.rdoc",
-    "Rakefile",
-    "VERSION",
-    "lib/generators/shellac/install_generator.rb",
-    "lib/generators/templates/config/varnish.yml",
-    "lib/generators/templates/varnish.yml",
-    "lib/shellac.rb",
-    "lib/shellac/actions.rb",
-    "lib/shellac/cache.rb",
-    "shellac.gemspec",
-    "test/helper.rb",
-    "test/test_shellac.rb"
-  ]
-  s.homepage = %q{http://github.com/bitflut/shellac}
-  s.licenses = ["MIT"]
+  s.name              = "shellac"
+  s.version           = Shellac::VERSION
+  s.description       = %q{Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem}
+  s.summary           = %q{Shellac is a gem to easily send purges to varnish servers from rails}
+  s.email             = %q{marian@bitflut.com}
+  s.homepage          = %q{http://github.com/bitflut/shellac}
+  s.authors           = ['Marian Andre']
+  s.license           = %q{MIT}
+  
+  s.files         = `git ls-files -- {shellac*,lib,spec,LICENSE.txt,README*,Gemfile}`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.5.2}
-  s.summary = %q{Shellac is a gem to easily send purges to varnish servers from rails}
-  s.test_files = [
-    "test/helper.rb",
-    "test/test_shellac.rb"
-  ]
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  s.add_dependency    'bundler',                    '~> 1.0'
+  s.add_runtime_dependency        'klarlack', '~> 0.0.6'
+  
+  s.add_development_dependency    'rspec-rails', '~> 2.5'
+  s.add_development_dependency    'rcov', ">= 0"
+  s.add_development_dependency    'rails', '3.0.7.rc2'
+  s.add_development_dependency    'sqlite3', '~> 0.0.6'
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<klarlack>, ["~> 0.0.6"])
-      s.add_development_dependency(%q<shoulda>, [">= 0"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
-      s.add_runtime_dependency(%q<klarlack>, ["~> 0.0.6"])
-    else
-      s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
-      s.add_dependency(%q<shoulda>, [">= 0"])
-      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-      s.add_dependency(%q<rcov>, [">= 0"])
-      s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
-    end
-  else
-    s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
-    s.add_dependency(%q<shoulda>, [">= 0"])
-    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
-    s.add_dependency(%q<rcov>, [">= 0"])
-    s.add_dependency(%q<klarlack>, ["~> 0.0.6"])
-  end
+  s.files             = [
+    '.gitignore',
+    'LICENSE.txt',
+    'README.rdoc',
+    'Rakefile',
+    'lib',
+    'lib/generators',
+    'lib/generators/shellac',
+    'lib/generators/shellac/install_generator.rb',
+    'lib/generators/templates',
+    'lib/generators/templates/config',
+    'lib/generators/templates/config/varnish.yml',
+    'lib/shellac',
+    'lib/shellac/actions.rb',
+    'lib/shellac/cache.rb',
+    'lib/shellac.rb',
+    'shellac.gemspec',
+    'spec',
+    'spec/shellac_spec.rb',
+    'spec/spec_helper.rb'
+  ]
 end
-

data/spec/shellac_spec.rb

@@ -0,0 +1,31 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Shellac" do
+  it "should add purge as a class method to ActionController::Base" do
+    ActionController::Base.methods.include?(:purge).should be_true
+  end
+  
+  it "should add purge as an instance method to ActionController::Base" do
+    ActionController::Base.instance_methods.include?(:purge).should be_true
+  end
+  
+  context "(rails performs caching)" do
+    before(:each) do
+      ActionController::Base.perform_caching = true
+    end
+    
+    it "should raise error if varnish is not available" do
+      lambda {ActionController::Base.purge("/")}.should raise_error(Errno::ECONNREFUSED)
+    end
+  end
+  
+  context "(rails doesn't perform caching)" do
+    before(:each) do
+      ActionController::Base.perform_caching = false
+    end
+    
+    it "should return nil" do
+      ActionController::Base.purge("/").should be nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../config/environment", __FILE__)
+require 'rspec/rails'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

metadata

@@ -2,81 +2,81 @@
 name: shellac
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2.1
+  version: 0.0.2.3
 platform: ruby
 authors: 
-- Marian
+- Marian Andre
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-04-12 00:00:00 +02:00
+date: 2011-04-17 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: klarlack
+  name: bundler
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 0.0.6
+        version: "1.0"
   type: :runtime
   prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: klarlack
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        version: "0"
-  type: :development
+        version: 0.0.6
+  type: :runtime
   prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: bundler
+  name: rspec-rails
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: "2.5"
   type: :development
   prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: jeweler
+  name: rcov
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.2
+        version: "0"
   type: :development
   prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: rcov
+  name: rails
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        version: "0"
+        version: 3.0.7.rc2
   type: :development
   prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  name: klarlack
+  name: sqlite3
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
         version: 0.0.6
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: *id006
 description: Shellac gives you an environment aware helper for purging configured under config/varnish.yml built ontop of Max Schoefmann's klarlack gem
@@ -85,26 +85,21 @@ executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE.txt
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
-- .document
-- Gemfile
-- Gemfile.lock
+- .gitignore
 - LICENSE.txt
 - README.rdoc
 - Rakefile
-- VERSION
 - lib/generators/shellac/install_generator.rb
 - lib/generators/templates/config/varnish.yml
-- lib/generators/templates/varnish.yml
-- lib/shellac.rb
 - lib/shellac/actions.rb
 - lib/shellac/cache.rb
+- lib/shellac.rb
 - shellac.gemspec
-- test/helper.rb
-- test/test_shellac.rb
+- spec/shellac_spec.rb
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/bitflut/shellac
 licenses: 
@@ -119,7 +114,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: -1693957586213964393
+      hash: 4382317821384086881
       segments: 
       - 0
       version: "0"
@@ -128,6 +123,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 4382317821384086881
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
@@ -137,5 +135,5 @@ signing_key:
 specification_version: 3
 summary: Shellac is a gem to easily send purges to varnish servers from rails
 test_files: 
-- test/helper.rb
-- test/test_shellac.rb
+- spec/shellac_spec.rb
+- spec/spec_helper.rb

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/Gemfile

@@ -1,13 +0,0 @@
-source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-gem "klarlack", "~> 0.0.6"
-
-# Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
-group :development do
-  gem "shoulda", ">= 0"
-  gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.5.2"
-  gem "rcov", ">= 0"
-end

data/Gemfile.lock

@@ -1,22 +0,0 @@
-GEM
-  remote: http://rubygems.org/
-  specs:
-    git (1.2.5)
-    jeweler (1.5.2)
-      bundler (~> 1.0.0)
-      git (>= 1.2.5)
-      rake
-    klarlack (0.0.6)
-    rake (0.8.7)
-    rcov (0.9.9)
-    shoulda (2.11.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.0.0)
-  jeweler (~> 1.5.2)
-  klarlack (~> 0.0.6)
-  rcov
-  shoulda

data/VERSION

@@ -1 +0,0 @@
-0.0.2.1

data/lib/generators/templates/varnish.yml

@@ -1,25 +0,0 @@
-# Define varnish for all environments that make use of it.
-# Currently all options must be specified. This will change in a future
-# version to only need definition of non default values of varnish.
-
-# host:       The host which you access your varnish server from. This 
-#             is particularly useful when you cache more than one host
-#             with one varnish instance (default: localhost)
-
-# post:       The port of your varnish telnet server (default: 6082)
-
-# timeout:    Timeout in seconds when connecting to varnish (default: 1)
-
-# keep_alive: Set to true, to keep the connection alive (default: false)
-
-development:
-  host: localhost
-  port: 6082
-  timeout: 1
-  keep_alive: false
-  
-production:
-  host: example.com
-  port: 6082
-  timeout: 1
-  keep_alive: false

data/test/helper.rb

@@ -1,18 +0,0 @@
-require 'rubygems'
-require 'bundler'
-begin
-  Bundler.setup(:default, :development)
-rescue Bundler::BundlerError => e
-  $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
-  exit e.status_code
-end
-require 'test/unit'
-require 'shoulda'
-
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'shellac'
-
-class Test::Unit::TestCase
-end

data/test/test_shellac.rb

@@ -1,7 +0,0 @@
-require 'helper'
-
-class TestShellac < Test::Unit::TestCase
-  should "probably rename this file and start testing for real" do
-    flunk "hey buddy, you should probably rename this file and start testing for real"
-  end
-end