pupu 0.0.1 → 0.0.2.pre

data/CHANGELOG

@@ -1 +1,12 @@
-[12/2/2008] First root release
+= Version 0.0.1
+  * CLI interface with search, install & uninstall
+  * Rake & Thor tasks wrapping the CLI interface
+  * Helpers
+  * Dependencies handling
+  * Metadata handling
+  * Rango & Merb support
+  * Rango & Merb examples
+
+= Version 0.0.2
+  * Rails support
+  * Better documentation

data/README.textile

@@ -1,6 +1,14 @@
-h1. About
+h1. About Pupu
 
-Pupu is a plugin system for media stuff like JS & CSS frameworks, plugins for the JS & CSS frameworks, icon sets etc. It knows dependencies and it has CLI interface, so it's really easy to bundle such plugins into your app.
+"Pupu":http://github.com/botanicus/pupu is a framework-agnostic plugin system for media stuff like JS/CSS frameworks and its plugins, icon sets etc. You can "search GitHub":http://github.com/search?type=Repositories&language=&q=pupu&repo=&langOverride=&x=9&y=24&start_value=1 for more examples. It provides CLI interface for searching, installing and updating pupus from GitHub and it also provides a helper for including static files from pupu into your HTML page. Both CLI and helper can handle dependencies.
+
+CLI example:
+
+<pre>
+pupu install botanicus/autocompleter
+~ Downloading botanicus/autocompleter
+~ Downloading dependency botanicus/mootools
+</pre>
 
 h1. Why I wrote it
 
@@ -8,72 +16,50 @@ In my apps the root/ stuff always get bloated and messy when I have all javascri
 
 Another thing which really annoyed me was the bloody <code>js_include_tag</code> and <code>css_include_tag</code>. There are so stupid that they do not throw exception when the JS or CSS file do not exists! So you are surprised why you fancy script do not work and then you realized that it's not correctly included at all!
 
-h1. What can be presented in pupu?
-
-Everything what can be put into root directory. Some examples: blueprint css, mootools, autocompleter for mootools, icon set ...
-
 h1. CLI interface
 
-h2. Specify @--media-root=path/to/media/directory@ and Optionally @--strategy=copy|submodules@
+If you are storing your media files in different directory than in @public@ or @media@ or if you want to use submodules strategy, you will need some "setup":http://wiki.github.com/botanicus/pupu/setup. *In case you are using defaults, everything should just work out of the box.*
 
-You don't have to do anything with environment, just specify @--media-root=path@ and it will work. Example: @pupu install mootools --media-root=media@
-
-h2. Using System @pupu@ and Configuration File
-
-- pupu executable will find it
-- you will require it in your environment file so it will be available in runtime
+<pre>
+# list all available pupus
+pupu search
 
-h2. Using Your Own Wrapper
+# search for pupu matching mootools in its name (you can use regexp)
+pupu search mootools
 
-If you have bundled application
-The only thing you need to do is just load your environment before pupu starts, example
+# install autocompleter and its dependencies from my github repo
+pupu install botanicus/autocompleter
 
-Rango:
-<pre>
-#!init
+# or uninstall, it's the same
+pupu uninstall autocompleter
 
-load File.dirname(__FILE__) + "/gems/gems/pupu-0.0.1/bin/pupu"
+# list all installed pupus
+pupu list
 </pre>
 
-Rails/Merb
-<pre>
-#!/usr/bin/env ruby1.9
-
-load File.dirname(__FILE__) + "../config/environment.rb"
-</pre>
+h1. Runtime Setup
 
-h2. Wrapper Tasks
+Command-line interface doesn't require any setup, runtime needs some.
 
-Pupu provides Rake & Thor tasks
+At the moment "Rango":http://github.com/botanicus/rango, "Merb":http://github.com/merb/merb and Rails are supported directly. If you are using one of these frameworks, just use @require "pupu/adapters/rango"@ in your environment file.
 
-<pre>
-task "pupu:setup" => :environment
-</pre>
+Rango actually will have stack generator in "upcoming version 0.2":http://wiki.github.com/botanicus/rango/roadmap, so then you can just run @rango create stack my_blog@ and it will work with Pupu out of the box.
 
-<pre>
-Pupu::Tasks.class_eval do
-  def setup
-    load "config/environment.rb"
-  end
-end
-</pre>
+If your framework isn't supported, just:
 
 <pre>
-# install autocompleter and its dependencies from my github repo
-pupu install botanicus/autocompleter
+require "myframework"
+require "pupu"
+require "pupu/helpers"
 
-# or uninstall, it's the same
-pupu remove autocompleter
-
-# list all installed pupus
-pupu list
+Pupu.root = MyFramework.root
+Pupu.media_root = File.join(MyFramework.root, "media") # you don't have to set it if you are using public or media
+MyFrameworkHelpersModule.send(:include, Pupu::Helpers)
 </pre>
 
-h1. Storing Pupus in Your Project
-
-copy/submodules
+And it should work. Check existing "Rango":http://github.com/botanicus/pupu/blob/master/lib/pupu/adapters/rango.rb, "Merb":http://github.com/botanicus/pupu/blob/master/lib/pupu/adapters/merb.rb resp. "Rails":http://github.com/botanicus/pupu/blob/master/lib/pupu/adapters/rails.rb adapter for inspiration.
 
-h1. Views
+h1. Helpers
 
 In your views you can include all the plugin-related files this way:
 
@@ -96,65 +82,13 @@ Plugin[:autocompleter].image("spinner.gif")
 
 h1. Initializers
 
-Initializers are the only part of pupu which are not stored in <code>root/pupu</code>, but are copyied to <code>root/javascripts/initializers</code> and <code>root/stylesheets/initializers</code>. In contrary of files in <code>root/pupu</code>, initializers are intended for user editing.
-
-<pre>
-window.addEvent("domready", function() {
-  // do the init stuff
-})
-</pre>
-
-h1. Available pupus
-
-* "MooTools":http://github.com/botanicus/pupu-mootools
-* "Autocompleter":http://github.com/botanicus/pupu-autocompleter
-* "Squeezebox":http://github.com/botanicus/pupu-squeezebox
-* "Blueprint CSS":http://github.com/botanicus/pupu-blueprint
-* "Mooeditable":http://github.com/botanicus/pupu-mooeditable
-* "Tips":http://github.com/botanicus/pupu-tips
-* "Growl":http://github.com/botanicus/pupu-growl
-* "Ratings":http://github.com/botanicus/pupu-ratings
-* "Form defaults":http://github.com/botanicus/pupu-form-defaults
-* icon sets
-
-h1. I'd like to write my own pupu!
-
-h2. Plugin generator
+Initializers are the only part of pupu which are not stored in <code>root/pupu</code>, but are copyied to <code>[media_root]/javascripts/initializers</code> resp. <code>[media_root]/stylesheets/initializers</code>. In contrary to files in <code>[media_root]/pupu</code>, initializers are intended for user editing.
 
-<pre>
-pupu-gen pupu chunky_bacon
-# chunky_bacon/README
-# chunky_bacon/LICENSE
-# chunky_bacon/initializers/chunky_bacon.js
-# chunky_bacon/initializers/chunky_bacon.css
-# chunky_bacon/lib
-# chunky_bacon/lib/chunky_bacon.js
-# chunky_bacon/stylesheets
-# chunky_bacon/stylesheets/chunky_bacon.css
-</pre>
-
-<pre>
-pupu-gen pupu chunky_bacon helpers.js blue.css
-</pre>
-
-h2. Configuration file
-
-File config.rb in your pupu root is intended to put package metadata there. You can define dependencies of pupu, arguments of pupu method and define which javascripts and stylesheets will be included in which order.
-
-<pre>
-# autocompleter depends on mootools
-dependencies :mootools
-
-# javascripts for loading
-javascripts "observer", "autocompleter", :in => "lib"
-
-parameter :type, :optional => ["local", "request"] do |type|
-  javascript "lib/autocompleter.#{type}"
-end
-</pre>
+Example from "botanicus/flash":http://github.com/botanicus/pupu-flash: "flash.js":http://github.com/botanicus/pupu-flash/blob/master/initializers/flash.js, "flash.css":http://github.com/botanicus/pupu-flash/blob/master/initializers/flash.css
 
 h1. Links
 
 - "Wiki":http://wiki.github.com/botanicus/pupu
 - "Source Code":http://github.com/botanicus/pupu
 - "API Documentation":http://rdoc.info/projects/botanicus/pupu
+- Examples: "Rango":http://github.com/botanicus/pupu/tree/master/examples/rango, "Merb":http://github.com/botanicus/pupu/tree/master/examples/merb

data/Rakefile

@@ -1,61 +1,24 @@
-#!/usr/bin/env rake1.9
 # encoding: utf-8
 
-# http://support.runcoderun.com/faqs/builds/how-do-i-run-rake-with-trace-enabled
-Rake.application.options.trace = true
-
-task :setup => ["submodules:init"]
-
-namespace :submodules do
-  desc "Init submodules"
-  task :init do
-    sh "git submodule init"
-  end
+require_relative "lib/pupu"
 
-  desc "Update submodules"
-  task :update do
-    Dir["vendor/*"].each do |path|
-      if File.directory?(path) && File.directory?(File.join(path, ".git"))
-        Dir.chdir(path) do
-          puts "=> #{path}"
-          puts %x[git reset --hard]
-          puts %x[git fetch]
-          puts %x[git reset origin/master --hard]
-          puts
-        end
-      end
-    end
-  end
-end
+# ENV setup for external commands
+ENV["RUBYLIB"] = Dir["vendor/*/lib"].join(":")
+$LOAD_PATH.clear.push(*Dir["vendor/*/lib"])
 
-task :gem do
-  sh "gem build pupu.gemspec"
-end
-
-desc "Release new version of pupu"
-task release: ["release:tag", "release:gemcutter"]
-
-namespace :release do
-  desc "Create Git tag"
-  task :tag do
-    require_relative "lib/pupu"
-    puts "Creating new git tag #{Pupu::VERSION} and pushing it online ..."
-    sh "git tag -a -m 'Version #{Pupu::VERSION}' #{Pupu::VERSION}"
-    sh "git push --tags"
-    puts "Tag #{Pupu::VERSION} was created and pushed to GitHub."
-  end
+# http://support.runcoderun.com/faqs/builds/how-do-i-run-rake-with-trace-enabled
+Rake.application.options.trace = true
 
-  desc "Push gem to Gemcutter"
-  task :gemcutter => :gem do
-    puts "Pushing to Gemcutter ..."
-    sh "gem push #{Dir["*.gem"].last}"
+# default task for RunCodeRun.com
+task :default => ["submodules:init", :spec]
+
+# load tasks
+Dir["tasks/*.rake"].each do |taskfile|
+  begin
+    load File.join(Dir.pwd, taskfile)
+  rescue Exception => exception
+    puts "Exception #{exception.class} occured during loading #{taskfile}:"
+    puts exception.message
+    puts exception.backtrace
   end
 end
-
-desc "Run specs"
-task :default => :setup do
-  rubylib = (ENV["RUBYLIB"] || String.new).split(":")
-  libdirs = Dir["vendor/*/lib"]
-  ENV["RUBYLIB"] = (libdirs + rubylib).join(":")
-  exec "./script/spec --options spec/spec.opts spec"
-end

data/TODO.txt

@@ -1,15 +1,20 @@
 === Version 0.1 ===
-metadata vzdycky, dat je do ignore
-pupu has a license, but the stuff we want to put into pupu probably has also a license (MooTools is under MIT etc)
+- Pupu.framework_root: "."
+- Pupu.media_root: "media"
+- Pupu.root: "media/pupu"
+- @pupu.root: "media/pupu/mootools"
+
+- rango & merb apps: both with same functionality include specs
+
+- THERE SHOULD BE A CONVETION TO NAME PUPU WITH PUPU-FRAMEWORK-PLUGIN, FOR EXAMPLE PUPU-MOOTOOLS-FLASH because of search
+- install each dependency just once
+- how to handle metadata if we have it as submodules? (suggestions: media/pupu/metadata.yml for all) or on the fly from .git/config & config.rb etc
+- pupu has a license, but the stuff we want to put into pupu probably has also a license (MooTools is under MIT etc)
 - media support (.swf): media helper
-- adapters for Rango, Merb, Rails (helpers registration)
 - media vs. root vs. custom
 - how to handle metadata? Generate metadata.yml from config.rb (dependencies) or generate it through merb-gen and write it by hand?
 - what about ruby helpers such as flash :notice, :error for flash <divs
-- custom messages on errors
-- install dependencies if any
 - add array with loaded plugins, do not load plugin which is already loaded
-- pupu view helper should works with dependencies (pupu :autocompleter should add mootools as well)
 
 === Version 0.2 ===
 

data/examples/merb/README.textile

@@ -0,0 +1,7 @@
+h1. Merb Example
+
+* Dependencies for running: @merb-core@
+* Run with @merb -a webrick@ (will start at @http://localhost:4000@)
+
+* Dependencies for testing: @rspec@, @webrat@
+* Specs: @spec spec/application_spec.rb --colour@

data/examples/merb/Rakefile

@@ -0,0 +1,30 @@
+require "rubygems"
+require "rake/rdoctask"
+
+require "merb-core"
+require "merb-core/tasks/merb"
+
+load "pupu/tasks/pupu.rake"
+
+# Load the basic runtime dependencies; this will include 
+# any plugins and therefore plugin rake tasks.
+init_env = ENV["MERB_ENV"] || "development"
+Merb.load_dependencies(:environment => init_env)
+     
+# Get Merb plugins and dependencies
+Merb::Plugins.rakefiles.each { |r| require r } 
+
+# Load any app level custom rakefile extensions from lib/tasks
+tasks_path = File.join(File.dirname(__FILE__), "lib", "tasks")
+rake_files = Dir["#{tasks_path}/*.rake"]
+rake_files.each{|rake_file| load rake_file }
+
+desc "Start runner environment"
+task :merb_env do
+  Merb.start_environment(:environment => init_env, :adapter => "runner")
+end
+
+require "spec/rake/spectask"
+require "merb-core/test/tasks/spectasks"
+desc "Default: run spec examples"
+task :default => "spec"

data/examples/merb/application.rb

@@ -0,0 +1,13 @@
+class MerbExample < Merb::Controller
+  def _template_location(action, type = nil, controller = controller_name)
+    controller == "layout" ? "layout.#{type}" : "#{action}.#{type}"
+  end
+
+  def index
+    render
+  end
+
+  def static
+    render params[:template]
+  end
+end

data/examples/merb/config/framework.rb

@@ -0,0 +1,7 @@
+Merb::Config[:framework] = {
+  :application => Merb.root / "application.rb",
+  :config => [Merb.root / "config", nil],
+  :public => [Merb.root / "public", nil],
+  :view   => Merb.root / "views"
+}
+

data/examples/merb/config/init.rb

@@ -0,0 +1,48 @@
+# Go to http://wiki.merbivore.com/pages/init-rb
+
+# setup $:
+pupu_libdir = File.expand_path("../../lib")
+raise Errno::ENOENT, "#{pupu_libdir} doesn't exist" unless File.directory?(pupu_libdir)
+$:.unshift(pupu_libdir)
+
+require "pupu/adapters/merb"
+
+use_orm :none
+use_test :rspec
+use_template_engine :erb
+
+# Specify a specific version of a dependency
+# dependency "RedCloth", "> 3.0"
+
+Merb::BootLoader.before_app_loads do
+  # This will get executed after dependencies have been loaded but before your app"s classes have loaded.
+end
+ 
+Merb::BootLoader.after_app_loads do
+  # This will get executed after your app"s classes have been loaded.
+end
+
+# Move this to application.rb if you want it to be reloadable in dev mode.
+Merb::Router.prepare do
+  with(controller: "merb_example") do
+    match("/").to(action: "index")
+    match("/examples/:template").to(action: "static")
+  end
+end
+
+Merb::Config.use do |config|
+  config[:environment]         = "development",
+  config[:framework]           = {},
+  config[:log_level]           = :debug,
+  config[:log_stream]          = STDOUT,
+  # or use file for logging:
+  # config[:log_file]          = Merb.root / "log" / "merb.log",
+  config[:use_mutex]           = false,
+  config[:session_store]       = "cookie",
+  config[:session_id_key]      = "_merb_session_id",
+  config[:session_secret_key]  = "55e74673c6b671fbcd32a405d9f41ab30fdc8ba3",
+  config[:exception_details]   = true,
+  config[:reload_classes]      = true,
+  config[:reload_templates]    = true,
+  config[:reload_time]         = 0.5
+end