rid 0.5.2 → 1.0.2

data/README.rdoc

@@ -1,92 +0,0 @@
-= Rid
-== Red in a different color
-
-Standalone Couchdb Application Development Suite
-
-With Rid you can easy build a standalone Couchdb application. Rid aims to bring some of the Rails beauty to Couchdb.
-Currently Rid supports Rails style Generators you will love, using the same awesome Thor library used in Rails 3.
-
-
-== Why?
-
-Why do we need a new Couchdb Application Development Suite? We already have the powerful {CouchApp}[http://github.com/couchapp/couchapp].
-
-I need more beauty. I want some elegance on the command line.
-
-I know my attempt is almost a small little step towards the beauty I aspire.
-I try to pilfer the most of now: From CouchApp and Ruby on Rails.
-So here we go:
-
-<em>Rid is designed to structure standalone Couchdb application development for maximum application portability.</em>
-
-=== Web development that doesn't hurt
-
-Rid is a set of open-source tools that's optimized for programmer happiness and sustainable productivity. It lets you write beautyful code by favoring convention over configuration.
-
-=== Write apps using just Javascript and HTML
-
-Render HTML documents using Javascript templates run by Couchdb. You'll get parallelism and cacheability, *using only HTML and Javascript*.
-Building standalone Couchdb applications according to correct principles affords you options not found on other platforms.
-
-
-== What comes next
-
-At the moment, Rid supports generating a scaffold application, pushing to a Couchdb server and pulling from a Couchdb.
-Rid injects the !code and !json makros introduced by CouchApp.
-
-The very next steps are:
-
-* add support for edit and delete
-
-
-== I need your help!
-
-The reason why I release that project in such an early state is that I beleave it's you, who invent that desired beauty!
-
-
-== Prerequisites
-
-All you need is Ruby and its packet manager RubyGems. If you do not have a Ruby environment,
-
-    apt-get install ruby rubygems
-
-will probably install the required packages. If you run into any troubles, visit http://docs.rubygems.org/read/chapter/3 for in deapth installation notes for RubyGems, and http://www.ruby-lang.org/en/downloads/ for help on installing Ruby.
-
-Of course, Rid relies on Couchdb. You do not have to install your own Couchdb server if you have access to a Couchdb database over the internet, but I recommend it for development.
-If you are new to Couchdb, install it:
-
-    apt-get install couchdb
-
-Take a look at the Couchdb Wiki, where the page http://wiki.apache.org/couchdb/Installation describes the installation for all common systems.
-
-
-== Installation
-
-Rid installation is easy.
-Rid is available as RubyGem, hosted on http://rubygems.org/ (aka Gemcutter) and Rubyforge (http://rubyforge.org).
-Install the gem with
-
-    gem install rid
-
-
-== Gettings started
-
-Once installed, your system will have the brand new +rid+ command.
-So just type
-
-  rid
-
-and relax.
-
-
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Commit, do not mess with rakefile, version, or history.
-* Send me a pull request. Bonus points for topic branches.
-
-
-== Copyright
-
-Copyright (c) 2010 Johannes Jörg Schmidt, TF. See LICENSE for details.

data/lib/rid/actions/base.rb

@@ -1,15 +0,0 @@
-require 'thor/group'
-require 'active_support/inflector'
-
-module Rid
-  module Actions
-    class Base < Thor::Group
-      include Thor::Actions
-
-      def self.banner
-        "rid #{to_s.split('::').last.underscore}"
-      end
-    end
-  end
-end
-

data/lib/rid/actions/pull.rb

@@ -1,28 +0,0 @@
-require 'rid/actions/base'
-require 'rid/design_document'
-
-require "rest_client"
-
-module Rid
-  module Actions
-    class Pull < Base
-      add_runtime_options!
-
-      def pull
-        doc = DesignDocument.new
-        say "Pulling %s" % doc.url
-
-        resp = RestClient.get doc.url(:attachments => true)
-        doc.json = resp.body
-
-        doc.write do |filename, content|
-          create_file filename, content
-        end
-
-        say "Checked out %s" % doc.rev
-      rescue RestClient::ResourceNotFound
-        say "Error: Document %s does not exist!" % doc.id
-      end
-    end
-  end
-end

data/lib/rid/actions/push.rb

@@ -1,53 +0,0 @@
-require 'rid/actions/base'
-require 'rid/design_document'
-
-require 'pathname'
-require "rest_client"
-
-module Rid
-  module Actions
-    class Push < Base
-      def initialize(*args)
-        super
-        @doc = DesignDocument.new
-      end
-
-      def create_database_unless_exists
-        RestClient.put @doc.database, nil
-        say "Created database %s" % @doc.database
-      rescue RestClient::PreconditionFailed
-      end
-
-      def push
-        root = Pathname.new(destination_root)
-        filenames = Dir[root.join "**/*"]
-        filenames.map! { |file| Pathname.new file }
-        filenames.map! { |path| path.relative_path_from root }
-        filenames.delete_if { |path| !path.file? }
-        filenames.map!(&:to_s)
-        @doc.read(filenames) do |filename|
-          File.read File.join(destination_root, filename)
-        end
-
-        say "Pushing to %s" % @doc.url
-
-        resp = RestClient.put @doc.url, @doc.json
-        response = JSON.parse(resp.body)
-
-        if response["ok"]
-          @doc.rev = response["rev"]
-          File.open File.join(destination_root, "_rev"), "w" do |file|
-           file << @doc.rev
-          end
-
-          say "Pushed %s" % @doc.rev
-        else
-          say "Error occured: %s" % response.inspect
-        end
-
-      rescue RestClient::Conflict
-        say "Conflict! Try to pull first or delete ./_rev."
-      end
-    end
-  end
-end

data/lib/rid/actions/routes.rb

@@ -1,44 +0,0 @@
-require 'rid/actions/base'
-
-module Rid
-  module Actions
-    class Routes < Base
-      def routes
-        static_files = Dir.glob(File.join(destination_root, "_attachments/*.html"))
-        longest_name = (%w[show list] + static_files.map { |f| File.basename(f, '.html') }).map(&:length).sort.last + 1
-
-        unless static_files.empty?
-          say 'Static'
-          static_files.each do |file|
-            say '  %s %s' % [(File.basename(file, '.html') + ":").ljust(longest_name), attachment_url(file)]
-          end
-        end
-
-        Dir.glob(File.join(destination_root, "views/*")).each do |model|
-          model_name = File.basename(model).singularize
-          say model_name.humanize
-          Dir.glob(File.join(destination_root, "shows/#{model_name}*")).each do |show|
-            say '  %s %s' % ["show:".ljust(longest_name), show_url(show, '/:id')]
-          end
-          Dir.glob(File.join(destination_root, "views/#{model_name}*")).each do |view|
-            say '  %s %s' % ["list:".ljust(longest_name), list_url(view, model)]
-          end
-        end
-      end
-
-      protected
-
-      def attachment_url(file)
-        File.join(Rid.database, '_design', File.basename(Rid.database), File.basename(file))
-      end
-
-      def list_url(view, list)
-        File.join(Rid.database, '_design', File.basename(Rid.database), '_list', File.basename(view), File.basename(list, '.js'))
-      end
-
-      def show_url(show, id = '/')
-        File.join(Rid.database, '_design', File.basename(Rid.database), '_show', File.basename(show, '.js'), id)
-      end
-    end
-  end
-end

data/lib/rid/commands/destroy.rb

@@ -1,9 +0,0 @@
-require 'rid/generators'
-
-if [nil, "-h", "--help"].include?(ARGV.first)
-  Rid::Generators.help 'destroy'
-  exit
-end
-
-name = ARGV.shift
-Rid::Generators.invoke name, ARGV, :behavior => :revoke, :destination_root => Rid.root

data/lib/rid/commands/generate.rb

@@ -1,9 +0,0 @@
-require 'rid/generators'
-
-if [nil, "-h", "--help"].include?(ARGV.first)
-  Rid::Generators.help 'generate'
-  exit
-end
-
-name = ARGV.shift
-Rid::Generators.invoke name, ARGV, :behavior => :invoke, :destination_root => Rid.root

data/lib/rid/commands/pull.rb

@@ -1,4 +0,0 @@
-require 'rid'
-require 'rid/actions/pull'
-
-Rid::Actions::Pull.start ARGV, :destination_root => Rid.root

data/lib/rid/commands/push.rb

@@ -1,4 +0,0 @@
-require 'rid'
-require 'rid/actions/push'
-
-Rid::Actions::Push.start ARGV, :destination_root => Rid.root

data/lib/rid/commands/routes.rb

@@ -1,4 +0,0 @@
-require 'rid'
-require 'rid/actions/routes'
-
-Rid::Actions::Routes.start ARGV, :destination_root => Rid.root

data/lib/rid/design_document.rb

@@ -1,149 +0,0 @@
-require 'rid/core_ext/hash'
-require 'rid/attachments'
-require 'rid/makros'
-
-require 'uri'
-
-module Rid
-  class DesignDocument
-    # Files that should have a .js extension
-    JAVASCRIPT_FILES = %w[
-      validate_doc_update
-      lists/*
-      shows/*
-      updates/*
-      views/*/*
-    ]
-
-    # Files that should not be included in document
-    EXCLUDE_FILES = %w[
-      README
-    ]
-
-    include Attachments
-    include Makros
-
-    attr_accessor :hash
-
-    def initialize
-      @hash = {}
-    end
-
-    # Read document from a filesystem.
-    #
-    # Takes a filename,
-    # many filenames,
-    # or an array of filenames
-    # and assign the return value of a yielded block to the hash.
-    #
-    # Nested hashes
-    # like { "hash" => { "key" => "value" } }
-    # can be constructed if the filename contains a slash (/),
-    # eg "hash/key".
-    #
-    def read(*filenames, &block)
-      filenames.flatten.uniq.each do |filename|
-        # skip exclude files
-        next if EXCLUDE_FILES.include?(filename)
-
-        key = filename.dup
-        # strip extname from javascript files
-        key.sub!(/\.js$/, '') if filename =~ /#{JAVASCRIPT_FILES.join('|')}/
-
-        hash.update_at key, block.call(filename)
-      end
-
-      map_attachments!
-      inject_makros!
-    end
-
-    # Write document to a filesystem
-    #
-    # Takes a directoy as startpoint (default is nil),
-    # a document hash (default is the design documents hash)
-    # and recursively yields all keys and values to the given block.
-    #
-    # Nested hashes
-    # like { "hash" => { "key" => "value" } }
-    # will result in the yielded filename
-    # "hash/key".
-    #
-    # The key "_attachments" has a special meaning:
-    # the value holds base64 encoded data as well as other metadata.
-    # This data will gets decoded and used as value for the key.
-    # 
-    def write(&block)
-      reduce_attachments!
-      reject_makros!
-
-      hash.flatten.each do |key, value|
-        filename = key.dup
-        # append extname to javascript files
-        filename << '.js' if filename =~ /#{JAVASCRIPT_FILES.join('|')}/
-
-        block.call(filename, value)
-      end
-    end
-
-    # Returns a JSON string representation of the documents hash
-    #
-    def json
-      hash.to_json
-    end
-
-    # Build the documents hash from a JSON string
-    #
-    def json=(json)
-      self.hash = JSON.parse(json)
-    end
-
-
-    # Accessor for id
-    def id
-      hash["_id"] || Rid.id
-    end
-
-    # Accessor for rev
-    def rev
-      hash["_rev"] || Rid.rev
-    end
-
-    # Updates rev in documents hash
-    def rev=(new_rev)
-      hash["_rev"] = new_rev
-    end
-
-
-    # Accessor for rid database
-    def database
-      @database ||= Rid.database
-    end
-
-    # Base URL for document
-    def base_url
-      @base_url ||= File.join(database, id)
-    end
-
-    # URL for accessing design document
-    # 
-    # Takes an optional options hash
-    # which gets converted to url encoded options
-    # and appended to the documents base url
-    #
-    def url(options = {})
-      base_url + build_options_string(options)
-    end
-
-
-    private
-
-    def build_options_string(options)
-      return '' if options.empty?
-      options_array = []
-      options.each do |key, value|
-        options_array << URI.escape([key, value].join('='))
-      end
-      '?' + options_array.join("&")
-    end
-  end
-end

data/lib/rid/generators/application/USAGE

@@ -1,10 +0,0 @@
-Description:
-    The 'application' generator creates a new Rid application
-    with a default directory structure and configuration
-    at the path you specify.
-
-Example:
-    rid generate application ~/rid/weblog
-
-    This generates a skeletal Rid installation in ~/rid/weblog.
-    See the README in the newly created application to get going.

data/lib/rid/generators/application/application_generator.rb

@@ -1,56 +0,0 @@
-module Rid::Generators
-  class ApplicationGenerator < Base
-    argument :app_path, :type => :string
-
-    def create_root
-      self.destination_root = File.expand_path(app_path, destination_root)
- 
-      empty_directory '.'
-      FileUtils.cd(destination_root) if File.directory?(destination_root)
-    end
-
-    def create_root_files
-      template "ridrc", ".ridrc"
-      copy_file "README"
-      copy_file "gitignore", ".gitignore" unless options[:skip_git]
-      template "_id"
-      copy_file "validate_doc_update.js"
-      empty_directory "lists"
-      empty_directory "shows"
-      empty_directory "updates"
-      empty_directory "views"
-    end
-
-    def create_attachments_files
-      empty_directory "_attachments"
-      inside "_attachments" do
-        empty_directory "images"
-        empty_directory "javascripts"
-        directory "stylesheets"
-        template "index.html"
-      end
-    end
-
-    def create_lib_files
-      empty_directory "lib"
-      inside "lib" do
-        copy_file "mustache.js"
-        copy_file "path.js"
-        empty_directory "templates"
-        inside "templates" do
-          template "layout.mustache"
-        end
-      end
-    end
-
-    protected
-
-    def app_name
-      @app_name ||= File.basename(destination_root)
-    end
-
-    def app_title
-      @app_title ||= app_name.humanize
-    end
-  end
-end

data/lib/rid/generators/application/templates/README

@@ -1 +0,0 @@
-# Welcome to Rid!

data/lib/rid/generators/application/templates/_attachments/index.html

@@ -1,11 +0,0 @@
-<!DOCTYPE HTML>
-<html>
-  <head>
-    <meta http-equiv="content-type" content="text/html; charset=utf-8">
-    <title><%= app_title %></title>
-    <link rel="stylesheet" href="stylesheets/application.css" type="text/css" media="screen" charset="utf-8">
-  </head>
-  <body>
-    <h1>Welcome to <%= app_title %>!</h1>
-  </body>
-</html>

data/lib/rid/generators/application/templates/_attachments/stylesheets/application.css

@@ -1,25 +0,0 @@
-body {
-  background-color: #fff;
-  color: #333;
-  margin: 1cm 1.618cm;
-}
-
-body, p, ol, ul, td {
-  font-family: verdana, arial, helvetica, sans-serif;
-  font-size:   13px;
-  line-height: 18px;
-}
-
-pre {
-  background-color: #eee;
-  padding: 10px;
-  font-size: 11px;
-}
-
-a { color: #000; }
-a:visited { color: #666; }
-a:hover { color: #fff; background-color:#000; }
-
-.notice {
-  color: green;
-}

data/lib/rid/generators/application/templates/_id

@@ -1 +0,0 @@
-_design/<%= app_name %>