packr-rails 0.0.1

data/.gitignore

@@ -0,0 +1,9 @@
+.DS_Store
+.bundle
+.rbx
+.*~
+Gemfile.lock
+pkg/*
+*.gem
+*.rbc
+*~

data/.travis.yml

@@ -0,0 +1,10 @@
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - ree
+  - ruby-head
+  - rbx
+  - rbx-2.0
+  - jruby
+notifications:
+  disabled: true

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in packr-rails.gemspec
+gemspec
+
+gem 'rails', '~> 3.1.0'
+
+group :test do
+  group :darwin do
+    gem 'rb-fsevent'
+  end
+end

data/Guardfile

@@ -0,0 +1,10 @@
+guard 'bundler' do
+  watch('Gemfile')
+  watch(/^.+\.gemspec/)
+end
+
+guard 'minitest' do
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jonas Grimfelt, Merchii. http://merchii.com
+
+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.textile

@@ -0,0 +1,26 @@
+h1. PACKR-RAILS "!https://secure.travis-ci.org/merchii/packr-rails.png!":http://travis-ci.org/merchii/packr-rails
+
+_Rails Asset Pipeline transformer for javascript compession/obfuscation using Packr._
+
+h2. Installation
+
+Add to your @Gemfile@:
+
+<pre>
+  gem 'packr-rails'
+</pre>
+
+...and @bundle install@.
+
+h2. Usage
+
+TODO
+
+h2. Notes
+
+This gem was developed for our own requirements at *"Merchii":http://github.com/merchii*, so feel free to send pull-requests with enhancements of any kind (features, bug-fixes, documentation, tests, etc.) to make it better or useful for you as well.
+
+h2. License
+
+Released under the MIT license.
+Copyright (c) "Jonas Grimfelt":http://github.com/grimen, "Merchii":http://github.com/merchii

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << ['lib', 'spec']
+  t.pattern = "spec/*_spec.rb"
+end

data/lib/packr-rails.rb

@@ -0,0 +1 @@
+require 'packr/rails'

data/lib/packr/rails.rb

@@ -0,0 +1,10 @@
+module Packr
+  module Rails
+    autoload :Compressor, 'packr/rails/compressor'
+  end
+end
+
+require 'packr/rails/compressor'
+require 'packr/rails/template'
+require 'packr/rails/railtie'
+require 'packr/rails/version'

data/lib/packr/rails/compressor.rb

@@ -0,0 +1,16 @@
+require 'packr'
+
+module Packr
+  module Rails
+    class Compressor
+      def compress(data)
+        Packr.pack(data, compress_options)
+      end
+
+      # FIXME: Get options via context_class.
+      def compress_options
+        {} # Rails.config.packr.pack_options
+      end
+    end
+  end
+end

data/lib/packr/rails/railtie.rb

@@ -0,0 +1,51 @@
+require 'sprockets/railtie'
+
+module Packr
+  module Rails
+    class Railtie < ::Rails::Railtie
+
+      # == References:
+      #   - http://edgeguides.rubyonrails.org/asset_pipeline.html
+      #   - https://github.com/rails/sass-rails/blob/3-1-stable/lib/sass/rails/railtie.rb
+
+      DEFAULTS = {
+        :template_extension => '.packr',      # File-extension for the template files that should be packed automatically.
+        :packed_extension   => '.packed.js',  # File-extension for the packed javascript file.
+        :pack_options => {
+          :shrink_vars  => true,      # Compress local variable names.
+          :private      => true,      # Obfuscate 'private' identifiers, i.e. names beginning with a single underscore.
+          :base62       => false,     # Encode the program using base 62.
+          :protect      => []         # Variable names to protect from compression. Example: ['_this', 'that']
+        }
+      }
+
+      module PackrContext
+        attr_accessor :packr_config
+      end
+
+      config.packr = ActiveSupport::OrderedOptions.new(DEFAULTS)
+      config.packr.defaults = config.packr.dup
+
+      config.before_initialize do
+        require 'sprockets/engines'
+        Sprockets::Engines # force autoloading
+        Sprockets.register_engine config.packr.template_extension, Packr::Rails::Template
+      end
+
+      initializer :setup_packr do |app|
+        app.assets.context_class.extend(PackrContext)
+        app.assets.context_class.packr_config = app.config.packr
+      end
+
+      # == NOTE: Example of replacing default JS-compressor (optional):
+      #
+      #   initializer :setup_compression do |app|
+      #     if app.config.assets.compress
+      #       app.config.assets.js_compressor = Packr::Rails::Compressor.new
+      #     end
+      #   end
+      #
+
+    end
+  end
+end

data/lib/packr/rails/template.rb

@@ -0,0 +1,36 @@
+require 'tilt'
+
+module Packr
+  module Rails
+    class Template < Tilt::Template
+      self.default_mime_type = 'application/javascript'
+
+      def self.engine_initialized?
+        defined?(::Packr)
+      end
+
+      def initialize_engine
+        require_template_library 'packr'
+      end
+
+      def syntax
+        :packr
+      end
+
+      def prepare
+      end
+
+      def evaluate(scope, locals, &block)
+        Packr.pack(data, packr_options(scope))
+      end
+
+      def packr_options(scope)
+        packr_options_from_rails(scope)
+      end
+
+      def packr_options_from_rails(scope)
+        scope.environment.context_class.packr_config
+      end
+    end
+  end
+end

data/lib/packr/rails/version.rb

@@ -0,0 +1,5 @@
+module Packr
+  module Rails
+    VERSION = "0.0.1"
+  end
+end

data/packr-rails.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "packr/rails/version"
+
+Gem::Specification.new do |s|
+  s.name        = "packr-rails"
+  s.version     = Packr::Rails::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Merchii", "Jonas Grimfelt"]
+  s.email       = ["jonas@merchii.com", "grimen@gmail.com"]
+  s.homepage    = "http://github.com/merchii/packr-rails"
+  s.summary     = %q{Rails Asset Pipeline transformer for javascript compession/obfuscation using Packr.}
+  s.description = s.summary
+
+  s.rubyforge_project = "packr-rails"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'grimen-packr', '>= 3.1.2'
+  s.add_dependency 'railties',   '~> 3.1.0'
+  s.add_dependency 'actionpack', '~> 3.1.0'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'minitest'
+  s.add_development_dependency 'guard'
+  s.add_development_dependency 'guard-bundler'
+  s.add_development_dependency 'guard-minitest'
+  s.add_development_dependency 'mocha'
+  s.add_development_dependency 'sqlite3'
+end

data/spec/fixtures/rails_project/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/spec/fixtures/rails_project/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.1.0'
+
+# Bundle edge Rails instead:
+# gem 'rails',     :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3'
+
+# Gems used only for assets and not required
+# in production environments by default.
+group :assets do
+  gem 'packr-rails', :path => File.expand_path('../../..')
+  # gem 'coffee-rails', "~> 3.1.0"
+  # gem 'uglifier'
+end

data/spec/fixtures/rails_project/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.