more 0.0.3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Logan Raarup, August Lilleaas
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,140 @@
+More
+====
+
+*LESS on Rails.*
+
+More is a plugin for Ruby on Rails applications. It automatically parses your applications `.less` files through LESS and outputs CSS files.
+
+In details, More does the following:
+
+* Recursively looks for LESS (`.less`) files in `app/stylesheets`
+* Ignores partials (prefixed with underscore: `_partial.less`) - these can be included with `@import` in your LESS files
+* Saves the resulting CSS files to `public/stylesheets` using the same directory structure as `app/stylesheets`
+
+LESS
+----
+
+LESS extends CSS with: variables, mixins, operations and nested rules. For more information, see [http://lesscss.org](http://lesscss.org).
+
+Upgrading from less-for-rails
+=======================================
+
+The old `less-for-rails` plugin looked for `.less` files in `public/stylesheets`. This plugin looks in `app/stylesheets`.
+
+To migrate, you can either set `Less::More.source_path = Rails.root + "/public/stylesheets"`, or move your `.less` files to `app/stylesheets`.
+
+
+Installation
+============
+
+More depends on the LESS gem. Please install LESS first:
+
+	$ gem install less
+
+Rails Plugin
+------------
+
+Use this to install as a plugin in a Ruby on Rails app:
+
+	$ script/plugin install git://github.com/cloudhead/more.git
+
+Rails Plugin (using git submodules)
+-----------------------------------
+
+Use this if you prefer to use git submodules for plugins:
+
+	$ git submodule add git://github.com/cloudhead/more.git vendor/plugins/more
+	$ script/runner vendor/plugins/more/install.rb
+
+
+Usage
+=====
+
+Upon installation, a new directory will be created in `app/stylesheets`. Any LESS file placed in this directory, including subdirectories, will
+automatically be parsed through LESS and saved as a corresponding CSS file in `public/stylesheets`. Example:
+
+	app/stylesheets/clients/screen.less => public/stylesheets/clients/screen.css
+	
+If you prefix a file with an underscore, it is considered to be a partial, and will not be parsed unless included in another file. Example:
+
+	<file: app/stylesheets/clients/partials/_form.less>
+	@text_dark: #222;
+	
+	<file: app/stylesheets/clients/screen.less>
+	@import "partials/_form";
+	
+	input { color: @text_dark; }
+
+The example above will result in a single CSS file in `public/stylesheets/clients/screen.css`.
+
+
+Configuration
+=============
+
+To set the source path (the location of your LESS files):
+
+	Less::More.source_path = "/path/to/less/files"
+	
+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.
+
+	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
+
+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.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.
+
+	Less::More.header = false
+
+To configure More for a specific environment, add configuration options into the environment file, such as `config/environments/development.rb`.
+
+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
+=====
+
+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
+
+To delete all generated CSS files, run:
+
+	$ rake more:clean
+
+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
+
+
+Documentation
+=============
+
+To view the full RDoc documentation, go to [http://rdoc.info/projects/cloudhead/more](http://rdoc.info/projects/cloudhead/more)
+
+
+Contributors
+============
+* August Lilleaas ([http://github.com/augustl](http://github.com/augustl))
+* Logan Raarup ([http://github.com/logandk](http://github.com/logandk))
+
+LESS is maintained by Alexis Sellier [http://github.com/cloudhead](http://github.com/cloudhead)

data/Rakefile

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :test
+
+desc 'Test the more plugin.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+desc 'Generate documentation for the more plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'More'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.markdown')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), 'rails', 'init')

data/lib/more.rb

@@ -0,0 +1,168 @@
+# 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/rails/init.rb

@@ -0,0 +1,13 @@
+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?
+}

data/tasks/more_tasks.rake

@@ -0,0 +1,19 @@
+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
+    puts "Done."
+
+  end
+  
+  desc "Remove generated CSS files"
+  task :clean => :environment do
+    puts "Deleting files.."
+    Less::More.clean
+    puts "Done."
+  end
+end

data/test/less_cache_controller_test.rb

@@ -0,0 +1,31 @@
+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

data/test/more_test.rb

@@ -0,0 +1,82 @@
+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) }
+    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')
+    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

data/test/test_helper.rb

@@ -0,0 +1,42 @@
+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")
+  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'
+
+# Ugh.. shouldn't these be required for us?
+Dir.chdir("#{File.dirname(__FILE__)}/../") {
+  require "config/routes"
+  require 'app/controllers/less_cache_controller'
+}

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: more
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Alexis Sellier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-08 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: less
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: "    More is a plugin for Ruby on Rails applications. It automatically\n    parses your applications .less files through LESS and outputs CSS files.\n"
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.markdown
+- MIT-LICENSE
+- Rakefile
+- init.rb
+- lib/more.rb
+- rails/init.rb
+- tasks/more_tasks.rake
+- test/test_helper.rb
+- test/less_cache_controller_test.rb
+- test/more_test.rb
+has_rdoc: true
+homepage: http://github.com/cloudhead/more
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: LESS on Rails
+test_files: []
+