jail 0.1.0 → 0.1.1

data/README.md

@@ -1,8 +1,11 @@
 # 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.
+Found a nice Jquery plugin you'd like to try out ? Now starts the RSIs :
+Download, unpack, find the source files, open your app folder, drag in the javascript folder, drag in the stylesheet folder, drag in the images folder...  Oh but wait, there's a better version of (modal/fancybox/slider/datepicker...). Download, unpack, find the source... _This must stop !_
+
+Meet Jail : it puts all your Javascripts (& cie) in Rails, with just a click!
+
+**NOW** With the 158 (sept/12) [CDNJS libraries](/cdnjs/cdnjs).
 
 ## Install
 
@@ -18,24 +21,26 @@ http://localhost:3000/jail/
 
 Chose a plugin, follow the link, Install. You're done.
 
+
 ![jail](/charly/jail/raw/master/jail.png)
 
 ---
 
-Oh no wait you still have to add :
+Oh wait you might have to add :
 
     //=require myplugin.js
 
-Oh & you're not happy with the actual set of Jquery plugins proposed. Add your own!
+And if you're not happy with the actual set of Jquery plugins proposed. Add your own!
 
 config/initializers/jail.rb
 
     module Jail
       LOGIN = 'login:password' #optional
-      Github.add_githublist(Rails.root.join("config/jail.backboneplugins.yml"))
-      Github.add_githublist(Rails.root.join("config/jail.whatever.yml"))
+      Jail::Github.add_githublist(Rails.root.join("config/jail.backboneplugins.yml"))
+      Jail::Github.add_githublist(Rails.root.join("config/jail.whatever.yml"))
     end
 
+Buth the list is bound to grow quickly.
 
 ## Usage (alt)
 
@@ -48,7 +53,7 @@ But it must exist in the yaml file !!!
 
 ## Contribute
 
-The list of plugins are in a yaml file : config/prisoners.yml
+The list of plugins are in a yaml file : config/jail.jqueryplugins.yml
 Add more plugins and pull a request!
 Would it be better to have them in the db ?
 
@@ -57,13 +62,21 @@ Would it be better to have them in the db ?
 
 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).
+  - 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). **update** : it has one (of course)!
 
 ## TODO
 
-- plugin installed? (check file existence)
-- plugin outdated? (overkill ?)
-- bin/jail
+  - Pjax for laoding plugin
+  - plugin installed? (check file existence)
+  - plugin outdated? (overkill ?)
+  - bin/jail
+
+## Changelog
+
+  - 0.1.1 CDNJS Integration + Some Github Refactoring
+
+## Thanks to
 
+- [Walter Davis](/walterdavis) for suggesting the awesome idea of including the cdnjs library.
 
 This project rocks and uses MIT-LICENSE.

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

@@ -12,7 +12,9 @@
  *= require_tree .
  */
 
-body, div { margin: 0; padding:0;}
+body, div { 
+  font-family: "Lucida Sans Unicode", "Lucida Grande", sans-serif; 
+  margin: 0; padding:0;}
 
 
 #header, #page, #footer {
@@ -25,28 +27,41 @@ body, div { margin: 0; padding:0;}
   background-color: #444}
 
 #header a {
+  text-decoration: none;
   color: #EEE;}
 
+fieldset {
+  color: #444;
+  background-color: #CCC}
+
+legend {
+  padding: 3px 9px;
+  color: #CCC;
+  background-color: #444;
+  border: thin solid #222;
+}
+
+.smaller {
+  font-size: .7em;}
+
 .notice {
   text-align: center;
   background-color: #BCED91;
   border: thin solid #629632;
   color:; #629632;
-  padding: 18px;
-}
+  padding: 18px;}
 
 ul.jaillinks {
   width: 400px;
-  list-style: none;
-}
+  list-style: none;}
 
 ul.jaillinks li a {
   color: #777;
   display: block;
   text-decoration: none;
   padding: 6px;
-  border-bottom: thin dashed #DDD;
-} 
+  border-bottom: thin dashed #DDD;}
+
 ul.jaillinks li a:hover {
   background-color: #DDD}
 

data/app/controllers/jail/cdnjs_controller.rb

@@ -0,0 +1,20 @@
+require_dependency "jail/application_controller"
+
+module Jail
+  class CdnjsController < ApplicationController
+    def index
+      @cdnjs = Cdnjs.libs.map(&:name)
+    end
+
+    def show
+      @cdnjs = Cdnjs.find(params[:name])
+    end
+
+    def install
+      @cdnjs = Cdnjs.find(params[:name])
+      @cdnjs.install(params["files"])
+
+      redirect_to( "/jail/cdnjs/#{params[:name]}", :notice => "Installed!" )
+    end
+  end
+end

data/app/models/jail/cdnjs.rb

@@ -0,0 +1,68 @@
+module Jail
+  class Cdnjs
+    attr_reader :github, :root_path, :package_path
+    delegate    :name, :filename, :version, :description,
+                :homepage, :repositories, :maintainers, :to => :package #etc
+
+    def self.github
+      @github ||= Jail::Github.find("cdnjs", "cdnjs", "ajax/libs")
+    end
+
+    def self.libs
+      @libs ||= github.contents
+    end
+    libs # load & memoize cdnjs libraries
+
+    def self.lib(path)
+      github.where(path).contents
+    end
+
+    def self.find_path(name)
+      hash = libs.find { |hashie| hashie.path.split("/").last == name }
+      hash and hash.path # raise if not found ?
+    end
+
+    def self.find(name)
+      path = find_path(name)
+      lib = lib(path)
+
+      self.new(path, lib)
+    end
+
+    def initialize(path, lib)
+      @github       = self.class.github
+      @root_path    = path
+      @package_path = lib.find {|h| h.type == "file"}.path
+    end
+
+    def package
+      @package ||= Hashie::Mash.new ActiveSupport::JSON.decode( github.where(package_path).read )
+    end
+
+    # gets the version from the package.json & returns a path
+    def version_path
+      Pathname(root_path).join(version)
+    end
+
+    def files
+      @files ||= github.where(version_path).contents
+    end
+
+    def file(name)
+      github.where(version_path.join(name))
+    end
+
+    def mapped_files
+      files.map(&:name).group_by {|name| Pathname(name).extname }
+    end
+
+    def install(params)
+      files_to_write = params.map {|file, num| file if num == "1"}.compact!
+
+      files_to_write.each do |name|
+        file(name).download()
+      end
+    end
+
+  end
+end

data/app/models/jail/github.rb

@@ -1,7 +1,8 @@
 module Jail  
   # This is a wrapper around ::Github 
   class Github
-    attr_accessor :github, :name, :repo, :path, :spec
+    attr_reader    :github, :name, :repo, :spec
+    attr_accessor  :path
     cattr_accessor :githublist
 
     def self.add_githublist(yaml_path)
@@ -10,33 +11,38 @@ module Jail
     end
 
     self.githublist={}
-    add_githublist(Jail::Engine.root.join("config", "jail.jqueryplugins.yml"))
+    add_githublist( Jail::Engine.root.join("config", "jail.jqueryplugins.yml") )
 
     # TODO : raise if missing descr:
     def self.all
       githublist.group_by {|k, v| v[:descr].match(/\w+:/).to_s if v[:descr]}
     end
 
-    # Use this to initialize Github
-    def self.find(aname, arepo, apath = nil)
-      self.new.tap do |yo|
-        yo.name= aname
-        yo.repo= arepo
-        yo.path= apath
-        yo.spec= githublist["#{yo.name}/#{yo.repo}"]
+    # Uhh useless ? Or AR Sexy ?
+    def self.find(name, repo, path = nil)
+      new(name, repo).tap do |yo|
+        yo.path= path
       end
     end
 
-    # Sets github attr which holds the Github (API) instance
-    # used by repo, contents, readme etc
-    def initialize
-      @github = defined?(Jail::LOGIN) ? 
+    def initialize(name, repo)
+      @name= name
+      @repo= repo
+      @spec= self.class.githublist["#{@name}/#{@repo}"]
+      @github = defined?(Jail::LOGIN) ?
                   ::Github.new({ :basic_auth => Jail::LOGIN }) :
                   ::Github.new
     end
 
+    # another AR alike for chaining
+    def where(path)
+      self.path= path
+      self
+    end
+
+    # do I need this method ?
     def repos
-      github.repos.get(name, repo)
+      @repos ||= github.repos.get(name, repo)
     end
 
     def contents
@@ -50,49 +56,53 @@ module Jail
       github.markdown.render :text => text
     end
 
-    # TODO : raise error if path's not a file
-    def read(apath)
-      self.path= apath
+    def read
+      #raise "blah" unless contents.type == "file"
       text = Base64.decode64 contents.content
     end
 
-    def install
-      #contents._links[:git]
-      download(:js)
-      download(:css)
-      download(:img)
-    end
-
-    def remove
-      delete_file(:js)
-      delete_file(:css)
-      delete_file(:img)
-    end
-
-    private
-    def download(type = :js)
-      return if spec[type].blank?
-      text = read(spec[type])
-      target(type).open('w') {|f| f.write(text) }
+    def download(type = nil)
+      target(type).open('w') {|f| f.write( read ) }
     end
 
-    def delete_file(type = :js)
-      return if spec[type].blank?
-      self.path = spec[type]
+    def delete(type = nil)
       t = target(type) and t.exist? and t.delete
     end      
 
-    def target(type)
-      filename= Pathname(path).basename.to_s
+    def target(type=nil)
+      filename= Pathname(path).basename
+      type = type || extract_type(filename)
+      
       case type
-      when :js
+      when :js, :coffee
         Rails.root.join("vendor/assets/javascripts/#{filename}")
-      when :css
+      when :css, :scss, :less
         Rails.root.join("vendor/assets/stylesheets/#{filename}")
-      when :img
+      when :img, :png, :gif, :jpeg
         Rails.root.join("vendor/assets/images/#{filename}")
       end
     end
 
+    def extract_type(filename)
+      type = Pathname(filename).extname
+      type = type.gsub(/\./, "").to_sym
+    end
+    
+    #
+    # Depends on yaml files: dont use elsewhere
+    #
+    def write_all
+      [:js, :css, :img].each do |type|
+        where(spec[type]).download(type) if spec[type]
+      end
+    end
+    alias install write_all
+
+    def delete_all
+      [:js, :css, :img].each do |type|
+        where(spec[type]).delete(type) if spec[type]
+      end
+    end
+    alias remove delete_all
   end
 end

data/app/views/jail/cdnjs/_files.html.erb

@@ -0,0 +1,6 @@
+<%- @cdnjs.mapped_files.each do |ext, n_files| %>
+  <p><%= ext %></p>
+  <%- n_files.each do |file| %>
+    <br><%= file %>
+  <% end %>
+<% end %>

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

@@ -0,0 +1,11 @@
+<%#=debug @cdnjs %>
+
+<h1>
+  <%= link_to "CDNJS", "https://github.com/cdnjs/cdnjs" %> List of Javascripts Libraries
+</h1>
+
+<ul class='jaillinks'>
+  <%- @cdnjs.each do |name| %>
+    <li><%= link_to name, "/jail/cdnjs/#{name}" %></li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,26 @@
+<%- if flash[:notice] %>
+  <div class='notice'>
+    <%= flash[:notice] %>
+  </div>
+<% end %>
+
+<h1><%= @cdnjs.name %></h1>
+<p><%= @cdnjs.description %></p>
+
+<%= form_tag "/jail/cdnjs/#{@cdnjs.name}" do %>
+  <fieldset>
+    <legend>Files To Install (uncheck unnecesseray)</legend>
+    <%- @cdnjs.files.map(&:name).each do |name| %>
+      <p>  
+        <%= label_tag name %>
+        <%= check_box('files', name, {:checked => true}, checked_value="1", unchecked_value="0") %>
+      </p>
+    <% end %>
+    <%= submit_tag "Install" %> 
+  </fieldset>
+<% end %>
+
+<p>homepage: <%= link_to @cdnjs.homepage, @cdnjs.homepage %></p>
+<%- @cdnjs.repositories.map(&:url).each do |url| %>
+  <p>repository : <%= link_to url, url %></p>
+<% end %>

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

@@ -8,8 +8,16 @@
 </head>
 <body>
   <div id="header">
-    <h1><%=link_to "Jail", root_path %></h1>
-    Puts your assets in rails
+    <h1>
+      <%=link_to "Jail", root_path %> 
+      <span class='smaller'> - Puts your Js in Rails</span>
+    </h1>
+    <div style="text-align: center;">
+      <%= link_to "Jail's list", "/jail/" %>
+      |
+      <%= link_to "Cdnjs's List", "/jail/cdnjs" %>
+    </div>
+    
   </div>
 
   <div id="page">

data/config/routes.rb

@@ -1,10 +1,20 @@
 Jail::Engine.routes.draw do
 
   root :to => "githubs#index"
+  match "/cdnjs" => "cdnjs#index"
+  with_options(:name => /[^\/]+/ ) do |opt|
+    opt.match "/cdnjs/:name"  => "cdnjs#show",    :via => :get
+    opt.match "/cdnjs/:name"  => "cdnjs#install", :via => :post
+    #opt.match "/cdnjs/:name/remove"   => "cdnjs#remove"
+    #opt.match "/cdnjs/:name/*path"    => "cdnjs#show"
+  end
+
   with_options(:repo => /[^\/]+/ ) do |opt|
     opt.match ":name/:repo" => "githubs#show"
     opt.match ":name/:repo/install" => "githubs#install"
     opt.match ":name/:repo/remove" => "githubs#remove"
     opt.match ":name/:repo/*path" => "githubs#show"
   end
+
+
 end