rid 0.3.0

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "vendor/mustache.js"]
+	path = vendor/mustache.js
+	url = git://github.com/janl/mustache.js.git

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Johannes J. Schmidt
+
+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.rdoc

@@ -0,0 +1,93 @@
+= 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 {RidApp}[http://github.com/ridapp/ridapp].
+
+I miss some beauty. I miss 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 RidApp 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 RidApp.
+
+The next big steps are:
+
+* make use of mustache.js in generators
+* build a lightweight Javascript library to assist client side Javascript work
+* enhance generators to build a full flavored scaffold with all CRUD operations
+
+== 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/Rakefile

@@ -0,0 +1,72 @@
+require 'rubygems'
+require 'rake'
+require File.join(File.dirname(__FILE__), 'lib', 'rid', 'version')
+
+namespace :vendor do
+  desc "Update vendor"
+  task :update do
+    `git submodule update`
+  end
+
+  desc "vendor mustache"
+  task :mustache do
+    dir = File.expand_path('..', __FILE__)
+    source = File.join(dir, 'vendor/mustache.js/mustache.js')
+    target = File.join(dir, 'lib/rid/generators/application/templates/lib/')
+    FileUtils.cp source, target
+  end
+end
+
+desc "Vendor all"
+task :vendor => ["vendor:update", "vendor:mustache"]
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rid"
+    gem.version = Rid::VERSION
+    gem.summary = %Q{Standalone Couchdb Application Development Suite}
+    gem.description = %Q{With Couch you can easy build a standalone CouchDB application. Couch aims to bring some of the Rails beauty to CouchDB. Currently Couch supports Rails style Generators you will love, using the same awesome Thor library used in Rails3.}
+    gem.email = "schmidt@netzmerk.com"
+    gem.homepage = "http://github.com/jo/rid"
+    gem.authors = ["Johannes J. Schmidt"]
+    gem.rubyforge_project = "rid"
+    gem.add_dependency "thor", ">= 0.13.4"
+    gem.add_dependency "rest-client", ">= 1.4.1"
+    gem.add_dependency "json_pure", ">= 1.2.2"
+    gem.add_dependency "activesupport", ">= 3.0.0.beta"
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rid #{Rid::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/rid

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby1.8
+
+rid_path = File.expand_path('../../lib', __FILE__)
+$:.unshift(rid_path) if File.directory?(rid_path) && !$:.include?(rid_path)
+
+require 'rid'
+require 'rid/commands'

data/lib/rid.rb

@@ -0,0 +1,43 @@
+require 'rubygems'
+require 'yaml'
+require 'json'
+
+module Rid
+  CONFIG_FILENAME = ".ridrc"
+
+  def self.root
+    @root ||= find_root
+  end
+
+  def self.database
+    @database ||= config["database"]
+  end
+
+  def self.id
+    @id ||= File.read(File.join(root, '_id')).strip
+  end
+
+  def self.rev
+    @rev ||= File.read(File.join(root, '_rev')).strip rescue nil
+  end
+
+  private
+
+  def self.config
+    @config ||= YAML.load(File.open config_file)
+  end
+
+  def self.config_file
+    File.join root, CONFIG_FILENAME
+  end
+
+  def self.find_root
+    cwd = Dir.pwd
+    return cwd if File.exists?(File.join(cwd, CONFIG_FILENAME))
+    Dir.chdir("..") do
+      find_root unless cwd == Dir.pwd
+    end
+  rescue SystemCallError
+    # could not chdir, no problem just return
+  end
+end

data/lib/rid/actions/base.rb

@@ -0,0 +1,15 @@
+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

@@ -0,0 +1,28 @@
+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

@@ -0,0 +1,53 @@
+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

@@ -0,0 +1,41 @@
+require 'rid/actions/base'
+
+module Rid
+  module Actions
+    class Routes < Base
+      def routes
+        say 'Static:'
+        Dir.glob(File.join(destination_root, "_attachments/*.html")).each do |file|
+          say '  %s' % attachment_url(file)
+        end
+
+        say 'Lists:'
+        Dir.glob(File.join(destination_root, "lists/*")).each do |list|
+          Dir.glob(File.join(destination_root, "views/*")).each do |view|
+            say '  %s' % list_url(list, view)
+          end
+        end
+
+        say 'Shows:'
+        Dir.glob(File.join(destination_root, "shows/*")).each do |show|
+          say '  %s' % show_url(show)
+          say '  %s' % show_url(show, '/:id')
+        end
+      end
+
+      protected
+
+      def attachment_url(file)
+        File.join(Rid.database, '_design', File.basename(Rid.database), File.basename(file))
+      end
+
+      def list_url(list, view)
+        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/attachments.rb

@@ -0,0 +1,59 @@
+module Rid
+  module Attachments
+    # Mime type mapping from extensions
+    MIME_TYPE_MAPPING = {
+      ".html" => "text/html",
+      ".js" => "text/javascript",
+      ".css" => "text/css",
+    }
+
+    def reduce_attachments!
+      return hash unless hash["_attachments"]
+      attachments = {}
+      hash["_attachments"].each do |key, value|
+        data = value["data"]
+        next unless data
+        attachments.update key => decode_attachment(data)
+      end
+      hash.update "_attachments" => attachments
+    end
+
+    def map_attachments!
+      return unless hash["_attachments"]
+      attachments = {}
+      flatten_attachements(hash["_attachments"]).each do |key, value|
+        attachments.update key => {
+          "data" => encode_attachment(value),
+          "content_type" => mime_type_for(key)
+        }
+      end
+      self.hash.update "_attachments" => attachments
+    end
+
+    def flatten_attachements(doc, base = nil)
+      result = {}
+      doc.each do |key, value|
+        new_base = base ? [base, key].join('/') : key
+        if value.is_a?(Hash)
+          result.update flatten_attachements(value, new_base)
+        else
+          result.update new_base => value
+        end
+      end
+      result
+    end
+
+    def decode_attachment(data)
+      data.unpack("m").first
+    end
+
+    def encode_attachment(data)
+      [data].pack("m").gsub(/\s+/,'')
+    end
+
+    def mime_type_for(filename)
+      ext = File.extname(filename)
+      MIME_TYPE_MAPPING[ext] || 'text/plain'
+    end
+  end
+end