jail 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 Charles Sistovaris
+
+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.md

@@ -0,0 +1,57 @@
+# Jail
+
+Copying, pasting, 'curling', running after all those jquery-plugin files, trying to keep track, loosing them, pulling your hair off. This must stop !
+Put all your jquery plugins (or any other assets) in rails once and for all. 
+And if you want to free them, just open the gate.
+
+## Install
+
+    gem 'jail', :group => "development"
+
+config/routes.rb
+
+    mount Jail::Engine => "/jail"
+
+## Usage
+
+http://localhost:3000/jail/
+
+Chose a plugin, follow the link, Install. You're done.
+Oh no wait you still have to add :
+
+    //=require myplugin.js
+
+![jail](/charly/jail/raw/master/jail.png)
+
+## Usage (alt)
+
+While waiting for a bin/jail feature:
+
+    rails console
+    > Jail::Github.find("name", "repo").install
+
+But it must exist in the yaml file !!!
+
+## Contribute
+
+The list of plugins are in a yaml file : config/prisoners.yml
+Add more plugins and pull a request!
+Would it be better to have them in the db ?
+
+
+## Why an Engine ?
+
+Other approaches where : 
+  - create a gem for each jquery plugin. But that means updating the gem with the latest release of each plugin and nobody wants to keep track of dozens of repos. 
+  - Do a generator instead but, while the thought came to me while writing this gem, I didn't find any remote feature in Thor (may be wrong though since rails templates has it).
+
+## TODO
+
+- remove plugin
+- plugin installed? (check file existence)
+- plugin outdated? (overkill ?)
+- clean routes
+- bin/jail
+
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Jail'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/javascripts/jail/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require jquery
+//= require jquery_ujs
+//= require_tree .

data/app/assets/stylesheets/jail/application.css

@@ -0,0 +1,28 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */
+
+body, div { margin: 0; padding:0;}
+
+
+#header, #page, #footer {
+  width: 960px;
+  margin: 0 auto;
+  padding: 9px;}
+
+#header {
+  color: #CCC;
+  background-color: #444}
+
+#header a {
+  color: #EEE;}

data/app/controllers/jail/application_controller.rb

@@ -0,0 +1,4 @@
+module Jail
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/jail/githubs_controller.rb

@@ -0,0 +1,20 @@
+require_dependency "jail/application_controller"
+
+module Jail
+  class GithubsController < ApplicationController
+    def index
+      @githubs = Github.all
+    end
+
+    def show
+      @github = Github.find(params[:name], params[:repo], params[:path])
+    end
+
+    def install
+      @github = Github.find(params[:name], params[:repo])
+      @github.install
+      redirect_to root_path
+    end
+
+  end
+end

data/app/models/jail/github.rb

@@ -0,0 +1,75 @@
+module Jail  
+  # This is a wrapper around ::Github 
+  class Github
+    attr_accessor :github, :name, :repo, :path, :spec
+
+    # not memoizing for now
+    def self.githublist
+      @githublist = ::YAML.load_file(Jail::Engine.root.join("config", "prisoners.yml")).to_hash
+    end
+
+    def self.all
+      githublist.keys
+    end
+
+    # Use this to initialize Github
+    def self.find(aname = "harvesthq", arepo = "chosen", apath = nil)
+      self.new.tap do |yo|
+        yo.name= aname
+        yo.repo= arepo
+        yo.path= apath
+        yo.spec= githublist["#{yo.name}/#{yo.repo}"]
+      end
+    end
+
+    # Sets github attr which holds the Github (API) instance
+    # used by repo, contents, readme etc
+    def initialize
+      @github = defined?(Jail::LOGIN) ? 
+                  ::Github.new({ :basic_auth => Jail::LOGIN }) :
+                  ::Github.new
+    end
+
+    def repos
+      github.repos.get(name, repo)
+    end
+
+    def contents
+      self.path ||= "/"
+      github.repos.contents.get(name, repo, path)
+    end
+
+    def readme
+      text = Base64.decode64 github.repos.contents.readme(name, repo).content
+      github.markdown.render :text => text
+    end 
+
+    def install
+      #contents._links[:git]
+      download(:js)
+      download(:css)
+      download(:img)
+    end
+
+    private
+    def download(type = :js)
+      return if spec[type].blank?
+      self.path= spec[type]
+      text = Base64.decode64 contents.content
+      target(type).open('w') {|f| f.write(text)}
+    end
+
+    def target(type)
+      filename= Pathname(path).basename.to_s
+      case type
+      when :js
+        Rails.root.join("vendor/assets/javascripts/#{filename}")
+      when :css
+        Rails.root.join("vendor/assets/stylesheets/#{filename}")
+      when :img
+        Rails.root.join("vendor/assets/images/#{filename}")
+      end
+    end
+
+  end
+end

data/app/views/jail/githubs/index.html.erb

@@ -0,0 +1,10 @@
+
+<%# @githubs.each do |jqgithub| %>
+<ul>
+  <%- @githubs.each do |k| %>
+    <li><%= link_to "#{k}", k %></li>
+  <% end %>
+</ul>
+
+
+

data/app/views/jail/githubs/show.html.erb

@@ -0,0 +1,10 @@
+
+<h2><%=link_to "install", request.url + "/install" %></h2>
+<ul>
+  <%- @github.contents.each do |cont| %>
+    <li><%= link_to cont.name, cont._links[:html] %></li>
+  <% end %>
+</ul>
+
+
+<%=raw @github.readme %>

data/app/views/layouts/jail/application.html.erb

@@ -0,0 +1,20 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Jail</title>
+  <%= stylesheet_link_tag    "jail/application", :media => "all" %>
+  <%#= javascript_include_tag "jail/application" %>
+  <%#= csrf_meta_tags %>
+</head>
+<body>
+  <div id="header">
+    <h1><%=link_to "Jail", root_path %></h1>
+    Puts your assets in rails
+  </div>
+
+  <div id="page">
+    <%= yield %>
+  </div>
+
+</body>
+</html>

data/config/prisoners.yml

@@ -0,0 +1,49 @@
+
+# Forms
+simsalabim/sisyphus: 
+  :js: ""
+  :css: ""
+  :descr: "form:"
+ivaynberg/select2: 
+  :js: "select2.js"
+  :css: "select2.css"
+  :descr: "form:"
+devluis/ddslick: 
+  :js: "js/ddslick.js"
+  :descr: "form:"
+
+# Images
+tapmodo/Jcrop:
+  :js: "js/jquery.Jcrop.js"
+  :css: "css/jquery.Jcrop.css"
+  :img: "css/Jcrop.gif"
+  :descr: "image:"
+#it seems the many files feature is missing here
+gilbitron/nivo-slider:
+  :js: "jquery.nivo.slider.js"
+  :css: "themes/default/default.css"
+  :descr: "image:slider"
+
+# Map
+hpneo/gmaps:
+  :js: "gmaps.js"
+  :descr: "map:"
+
+# Navigation
+davist11/jquery-stickem:
+  :js: "jquery.stickem.js"
+  :descr: "navigation:"
+
+# Essentials
+scotthamper/cookies: 
+  :js: "cookies.js"
+  :descr: "essentials:"
+briancherne/jquery-hoverintent:
+  :js: "jquery.hoverIntent.js"
+  :descr: "essentials:"
+
+# Yup
+arturadib/strapdown: 
+  :js: "src/strapdown.js"
+  :css: "src/strapdown.css"
+  :desc: ""

data/config/routes.rb

@@ -0,0 +1,7 @@
+Jail::Engine.routes.draw do
+
+  root :to => "githubs#index"
+  match ":name/:repo" => "githubs#show"
+  match ":name/:repo/install" => "githubs#install"
+  match ":name/:repo/*path" => "githubs#show"
+end

data/lib/jail.rb

@@ -0,0 +1,6 @@
+require "rubygems"
+require "jail/engine"
+require "github_api"
+
+module Jail
+end

data/lib/jail/engine.rb

@@ -0,0 +1,5 @@
+module Jail
+  class Engine < ::Rails::Engine
+    isolate_namespace Jail
+  end
+end

data/lib/jail/version.rb

@@ -0,0 +1,3 @@
+module Jail
+  VERSION = "0.0.2"
+end

data/lib/tasks/jail_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :jail do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -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.