more 0.0.3 → 0.1.0

data/README.markdown

@@ -67,27 +67,25 @@ If you prefix a file with an underscore, it is considered to be a partial, and w
 
 The example above will result in a single CSS file in `public/stylesheets/clients/screen.css`.
 
+Any `.css` file placed in `app/stylesheets` will be copied into `public/stylesheets` without being parsed through LESS.
+
 
 Configuration
 =============
 
-To set the source path (the location of your LESS files):
+Source path: the location of your LESS files (default: app/stylesheets)
 
-	Less::More.source_path = "/path/to/less/files"
+	Less::More.source_path = "public/stylesheets/less"
 	
-You can also set the destination path. Be careful with the formatting here, since this is in fact a route, and not a regular path.
+Destination Path: where the css goes (public/destination_path) (default: stylesheets)
 
 	Less::More.destination_path = "css"
 
-More can compress your files by removing extra line breaks. This is enabled by default in the `production` environment. To change this setting, set:
-
-	Less::More.compression = true
+More can compress your files by removing extra line breaks (default: true)
 
-If you're on a read-only file system, you can turn page caching off and use Cache-Control headers. This option is on by default on Heroku (see separate section).
+	Less::More.compression = false
 
-	Less::More.page_cache = false
-  
-More inserts headers in the generated CSS files, letting people know that the file is in fact generated and shouldn't be edited directly. This is by default only enabled in development mode. You can disable this behavior if you want to.
+More inserts headers in the generated CSS files, letting people know that the file is in fact generated and shouldn't be edited directly. (default: true)
 
 	Less::More.header = false
 
@@ -95,12 +93,6 @@ To configure More for a specific environment, add configuration options into the
 
 If you wish to apply the configuration to all environments, place them in `config/environment.rb`.
 
-Heroku
-======
-
-The plugin works out-of-the-box on Heroku.
-
-Heroku has a read-only file system, which means caching the generated CSS with page caching is not an option. Heroku supports caching with Varnish, though, which the plugin will leverage by setting Cache-Control headers so that generated CSS is cached for one month.
 
 Tasks
 =====
@@ -109,7 +101,7 @@ More provides a set of Rake tasks to help manage your CSS files.
 
 To parse all LESS files and save the resulting CSS files to the destination path, run:
 
-	$ rake more:parse
+	$ rake more:generate
 
 To delete all generated CSS files, run:
 
@@ -118,13 +110,10 @@ To delete all generated CSS files, run:
 This task will not delete any CSS files from the destination path, that does not have a corresponding LESS file in the source path.
 
 
-Git
-===
-
-If you are using git to version control your code and LESS for all your stylesheets, you can add this entry to your `.gitignore` file:
-
-	public/stylesheets
+Git / SVN
+=========
 
+Check in all the generated css(destination path), they are only generated in development
 
 Documentation
 =============
@@ -136,5 +125,6 @@ Contributors
 ============
 * August Lilleaas ([http://github.com/augustl](http://github.com/augustl))
 * Logan Raarup ([http://github.com/logandk](http://github.com/logandk))
+* Michael Grosser ([http://github.com/grosser](http://github.com/grosser))
 
 LESS is maintained by Alexis Sellier [http://github.com/cloudhead](http://github.com/cloudhead)

data/lib/controller_extension.rb

@@ -0,0 +1,8 @@
+class ActionController::Base
+  def process_with_less(*args)
+    Less::More.generate_all
+    process_without_less(*args)
+  end
+
+  alias_method_chain :process, :less
+end

data/rails/init.rb

@@ -1,13 +1 @@
-begin
-  require 'less'
-rescue LoadError => e
-  e.message << " (You may need to install the less gem)"
-  raise e
-end
-
-require File.join(File.dirname(__FILE__), '..', 'lib', 'more')
-
-config.after_initialize {
-  Less::More.clean
-  Less::More.parse if Less::More.page_cache?
-}
+require File.join(File.dirname(__FILE__), '..', 'lib', 'controller_extension') if RAILS_ENV == 'development'

data/tasks/more_tasks.rake

@@ -1,19 +1,16 @@
-require 'less'
-require File.join(File.dirname(__FILE__), '..', 'lib', 'more')
-
 namespace :more do
   desc "Generate CSS files from LESS files"
-  task :parse => :environment do
-    puts "Parsing files from #{Less::More.source_path}."
-    Less::More.parse
+  task :generate => :environment do
+    puts "Generating css from less files in #{Less::More.source_path}."
+    Less::More.generate_all
     puts "Done."
 
   end
   
   desc "Remove generated CSS files"
   task :clean => :environment do
-    puts "Deleting files.."
-    Less::More.clean
+    puts "Deleting all generated css files in #{Less::More.destination_path}"
+    Less::More.remove_all_generated
     puts "Done."
   end
 end

data/test/more_test.rb

@@ -2,81 +2,101 @@ require 'test_helper'
 
 class MoreTest < Test::Unit::TestCase
   def setup
-    class << Less::More
-      [:@compression, :@header, :@page_cache].each {|v| remove_instance_variable(v) if instance_variable_defined?(v) }
+    [:compression, :header, :destination_path, :source_path].each do |variable|
+      Less::More.send("#{variable}=", nil)
     end
   end
-  
-
-  def test_getting_config_from_current_environment_or_defaults_to_production
-    Less::More::DEFAULTS["development"]["foo"] = 5
-    Less::More::DEFAULTS["production"]["foo"] = 10
-    
-    Rails.expects(:env).returns("development")
-    assert_equal 5, Less::More.get_cvar("foo")
-    
-    Rails.expects(:env).returns("production")
-    assert_equal 10, Less::More.get_cvar("foo")
-    
-    Rails.expects(:env).returns("staging")
-    assert_equal 10, Less::More.get_cvar("foo")
-  end
-  
-  def test_cvar_gets_predesence_for_user_values
-    Less::More::DEFAULTS["development"][:page_cache] = false
-    assert_equal false, Less::More.page_cache?
-    
-    Less::More.page_cache = true
-    assert_equal true, Less::More.page_cache?
-  end
-  
-  def test_page_cache_off_on_heroku
-    Less::More.page_cache = true
-    Less::More::DEFAULTS["development"][:page_cache] = true
-    
-    # The party pooper
-    Less::More.expects(:heroku?).returns(true)
-    
-    assert_equal false, Less::More.page_cache?
-  end
-  
-  def test_compression
-    Less::More.compression = true
-    assert_equal Less::More.compression?, true
-    
-    Less::More.compression = false
-    assert_equal Less::More.compression?, false
-  end
-  
-  def test_source_path
-    Less::More.source_path = "/path/to/flaf"
-    assert_equal Pathname.new("/path/to/flaf"), Less::More.source_path
-  end
-  
-  def test_exists
-    Less::More.source_path = File.join(File.dirname(__FILE__), 'less_files')
-    
-    assert Less::More.exists?(["test"])
-    assert Less::More.exists?(["short"])
-    assert Less::More.exists?(["sub", "test2"])
-    
-    # Partials does not exist
-    assert !Less::More.exists?(["_global"])
-    assert !Less::More.exists?(["shared", "_form"])
-  end
-  
-  def test_generate
-    Less::More.source_path = File.join(File.dirname(__FILE__), 'less_files')
+
+  def prepare_for_generate
+    Less::More.source_path = 'less_files'
+    Less::More.destination_path = 'css'
+
+    `rm -rf #{css_path}`
+    `mkdir -p #{css_path}`
+  end
+
+  def css_path
+    "#{Rails.root}/public/css"
+  end
+
+  def teardown
+    `rm -rf #{css_path}`
+  end
+
+  def test_default_for_header
+    assert_equal Less::More.header, true
+  end
+
+  def test_header_can_be_overwritten
+    Less::More.header = false
+    assert_equal false, Less::More.header
+  end
+
+  def test_default_for_source_path
+    assert_equal 'app/stylesheets', Less::More.source_path
+  end
+
+  def test_source_path_can_be_overwritten
+    Less::More.source_path = 'xxx'
+    assert_equal 'xxx', Less::More.source_path
+  end
+
+  def test_default_for_destination_path
+    assert_equal 'stylesheets', Less::More.destination_path
+  end
+
+  def test_destination_path_can_be_overwritten
+    Less::More.destination_path = 'xxx'
+    assert_equal 'xxx', Less::More.destination_path
+  end
+
+  def test_default_for_compression
+    assert_equal nil, Less::More.compression
+  end
+
+  def test_compression_can_be_overwritten
     Less::More.compression = true
-    
-    assert_equal ".allforms { font-size: 110%; }body { color: #222222; }form {  font-size: 110%;  color: #ffffff;}", Less::More.generate(["test"])
-  end
-  
-  def test_pathname_from_array
-    Less::More.source_path = File.join(File.dirname(__FILE__), 'less_files')
-    
-    assert Less::More.pathname_from_array(["test"]).exist?
-    assert Less::More.pathname_from_array(["short"]).exist?
-    assert Less::More.pathname_from_array(["sub", "test2"]).exist?
-  end
-end
+    assert_equal true, Less::More.compression
+  end
+
+  def test_generate_with_partials
+    prepare_for_generate
+    Less::More.generate_all
+    css = File.read(File.join(css_path, 'test.css'))
+    assert css.include?(".allforms { font-size: 110%; }
+body { color: #222222; }
+form {
+  font-size: 110%;
+  color: #ffffff;
+}")
+  end
+
+  def test_generate_does_not_parse_css
+    prepare_for_generate
+    Less::More.generate_all
+    original_css = File.read(File.join(css_path, 'plain.css'))
+    assert_equal File.read(File.join(Rails.root,'less_files', 'plain.css')), original_css
+  end
+
+  def test_generate_uses_header_when_set
+    prepare_for_generate
+    Less::More.header = true
+    Less::More.generate_all
+    css = File.read(File.join(css_path, 'test.css'))
+    assert_match /^\/\*/, css # starts with comment -> header
+  end
+
+  def test_generate_uses_no_header_when_not_set
+    prepare_for_generate
+    Less::More.header = false
+    Less::More.generate_all
+    css = File.read(File.join(css_path, 'test.css'))
+    assert_match /^\.allforms/, css
+  end
+
+  def test_generate_does_not_generate_partials
+    prepare_for_generate
+    Less::More.generate_all
+    assert !File.exist?(File.join(css_path, '_global.css'))
+  end
+end

data/test/test_helper.rb

@@ -1,42 +1,14 @@
 require 'test/unit'
 
 require 'rubygems'
-require 'mocha'
 require 'active_support'
-require 'action_controller'
 
-ActionController::Base.session_store = nil
-
-module Rails
-  extend self
-  
-  def env
-    "development"
-  end
-  
-  def root
-    Pathname.new("/tmp")
+class Rails
+  def self.root
+    File.expand_path(File.dirname(__FILE__))
   end
-  
-  def backtrace_cleaner
-    ActiveSupport::BacktraceCleaner.new
-  end
-end
-
-class ApplicationController < ActionController::Base
-end
-
-begin
-  require 'less'
-rescue LoadError => e
-  e.message << " (You may need to install the less gem)"
-  raise e
 end
 
-require 'more'
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
 
-# Ugh.. shouldn't these be required for us?
-Dir.chdir("#{File.dirname(__FILE__)}/../") {
-  require "config/routes"
-  require 'app/controllers/less_cache_controller'
-}
+require 'less/more'

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: more
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
-- Alexis Sellier
+- August Lilleaas
+- Logan Raarup
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-08 00:00:00 +02:00
+date: 2010-02-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,12 +36,11 @@ files:
 - MIT-LICENSE
 - Rakefile
 - init.rb
-- lib/more.rb
+- lib/controller_extension.rb
 - rails/init.rb
 - tasks/more_tasks.rake
-- test/test_helper.rb
-- test/less_cache_controller_test.rb
 - test/more_test.rb
+- test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/cloudhead/more
 licenses: []

data/lib/more.rb

@@ -1,168 +0,0 @@
-# Less::More provides methods for parsing LESS files in a rails application to CSS target files.
-# 
-# When Less::More.parse is called, all files in Less::More.source_path will be parsed using LESS
-# and saved as CSS files in Less::More.destination_path. If Less::More.compression is set to true,
-# extra line breaks will be removed to compress the CSS files.
-#
-# By default, Less::More.parse will be called for each request in `development` environment and on
-# application initialization in `production` environment.
-
-begin
-  require 'less'
-rescue LoadError => e
-  e.message << " (You may need to install the less gem)"
-  raise e
-end
-
-class Less::More
-  DEFAULTS = {
-    "production" => {
-      :compression        => true,
-      :header             => false,
-      :page_cache         => true,
-      :destination_path   => "stylesheets"
-    },
-    "development" => {
-      :compression        => false,
-      :header             => true,
-      :page_cache         => false,
-      :destination_path   => "stylesheets"
-    }
-  }
-  
-  HEADER = %{/*\n\n\n\n\n\tThis file was auto generated by Less (http://lesscss.org). To change the contents of this file, edit %s instead.\n\n\n\n\n*/}
-  
-  class << self
-    attr_writer :compression, :header, :page_cache, :destination_path
-    
-    # Returns true if compression is enabled. By default, compression is enabled in the production environment
-    # and disabled in the development and test environments. This value can be changed using:
-    #
-    #   Less::More.compression = true
-    #
-    # You can put this line into config/environments/development.rb to enable compression for the development environments
-    def compression?
-      get_cvar(:compression)
-    end
-
-    # TODO: Use controllers and page cache to generate the files.
-    def page_cache?
-      (not heroku?) && get_cvar(:page_cache)
-    end
-    
-    # Tells the plugin to prepend HEADER to all generated CSS, informing users
-    # opening raw .css files that the file is auto-generated and that the
-    # .less file should be edited instead.
-    #
-    #    Less::More.header = false
-    def header
-      result = get_cvar(:header)
-      get_cvar(:header) ? DEFAULT_HEADER : ""
-    end
-    
-    # The path, or route, where you want your .css files to live.
-    def destination_path
-      get_cvar(:destination_path)
-    end
-    
-    # Gets user set values or DEFAULTS. User set values gets precedence.
-    def get_cvar(cvar)
-      instance_variable_get("@#{cvar}") || (DEFAULTS[Rails.env] || DEFAULTS["production"])[cvar]
-    end
-    
-    # Returns true if the app is running on Heroku. When +heroku?+ is true,
-    # +page_cache?+ will always be false.
-    def heroku?
-      !!ENV["HEROKU_ENV"]
-    end
-    
-    # Returns the LESS source path, see `source_path=`
-    def source_path
-      @source_path || Rails.root.join("app", "stylesheets")
-    end
-    
-    # Sets the source path for LESS files. This directory will be scanned recursively for all *.less files. Files prefixed
-    # with an underscore is considered to be partials and are not parsed directly. These files can be included using `@import`
-    # statements. *Example partial filename: _form.less*
-    #
-    # Default value is app/stylesheets
-    #
-    # Examples:
-    #   Less::More.source_path = "/path/to/less/files"
-    #   Less::More.source_path = Pathname.new("/other/path")
-    def source_path=(path)
-      @source_path = Pathname.new(path.to_s)
-    end
-    
-    # Checks if a .less or .lss file exists in Less::More.source_path matching
-    # the given parameters.
-    #
-    #   Less::More.exists?(["screen"])
-    #   Less::More.exists?(["subdirectories", "here", "homepage"])
-    def exists?(path_as_array)
-      return false if path_as_array[-1].starts_with?("_")
-      
-      pathname = pathname_from_array(path_as_array)
-      pathname && pathname.exist?
-    end
-    
-    # Generates the .css from a .less or .lss file in Less::More.source_path matching
-    # the given parameters.
-    #
-    #   Less::More.generate(["screen"])
-    #   Less::More.generate(["subdirectories", "here", "homepage"])
-    #
-    # Returns the CSS as a string.
-    def generate(path_as_array)
-      source = pathname_from_array(path_as_array)
-      engine = File.open(source) {|f| Less::Engine.new(f) }
-      css = engine.to_css
-      css.delete!("\n") if self.compression?
-      css
-    end
-    
-    # Generates all the .css files.
-    def parse
-      Less::More.all_less_files.each do |path|
-        # Get path
-        relative_path = path.relative_path_from(Less::More.source_path)
-        path_as_array = relative_path.to_s.split(File::SEPARATOR)
-        path_as_array[-1] = File.basename(path_as_array[-1], File.extname(path_as_array[-1]))
-
-        # Generate CSS
-        css = Less::More.generate(path_as_array)
-
-        # Store CSS
-        path_as_array[-1] = path_as_array[-1] + ".css"
-        destination = Pathname.new(File.join(Rails.root, "public", Less::More.destination_path)).join(*path_as_array)
-        destination.dirname.mkpath
-
-        File.open(destination, "w") {|f|
-          f.puts css
-        }
-      end
-    end
-    
-    # Removes all generated css files.
-    def clean
-      all_less_files.each do |path|
-        relative_path = path.relative_path_from(Less::More.source_path)
-        css_path = relative_path.to_s.sub(/le?ss$/, "css")
-        css_file = File.join(Rails.root, "public", Less::More.destination_path, css_path)
-        File.delete(css_file) if File.file?(css_file)
-      end
-    end
-    
-    # Array of Pathname instances for all the less source files.
-    def all_less_files
-      Dir[Less::More.source_path.join("**", "*.{less,lss}")].map! {|f| Pathname.new(f) }
-    end
-    
-    # Converts ["foo", "bar"] into a `Pathname` based on Less::More.source_path.
-    def pathname_from_array(array)
-      path_spec = array.dup
-      path_spec[-1] = path_spec[-1] + ".{less,lss}"
-      Pathname.glob(self.source_path.join(*path_spec))[0]
-    end
-  end
-end

data/test/less_cache_controller_test.rb

@@ -1,31 +0,0 @@
-require 'test_helper'
-
-class LessCacheControllerTest < ActionController::IntegrationTest
-  def setup
-    Less::More.source_path = File.join(File.dirname(__FILE__), 'less_files')
-  end
-  
-  test "regular stylesheet" do
-    get "stylesheets/test.css"
-    assert_response :success
-    assert @response.body.include?("body { color: #222222; }")
-  end
-  
-  test "sub-folder" do
-    get "stylesheets/sub/test2.css"
-    assert_response :success
-    assert @response.body.include?("div { display: none; }")
-  end
-  
-  test "404" do
-    Less::More.expects(:generate).never
-    get "stylesheets/does_not_exist.css"
-    assert_response 404
-  end
-  
-  test "setting headers with page cache" do
-    Less::More.expects(:page_cache?).returns(false)
-    get "stylesheets/test.css"
-    assert @response.headers["Cache-Control"]
-  end
-end