rid 0.5.2 → 1.0.2

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Johannes J. Schmidt
+Copyright (c) 2010 Johannes J. Schmidt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README

@@ -0,0 +1,14 @@
+= Rid
+
+In the spirit of Ruby on Rails Rid tends on programmers happiness.
+
+Rid eases the process of building standalone CouchDB applications
+with tools for deployment, codegenerators and a javascript library.
+
+This is the rid gem with the CouchDB model and command line
+infrastructure.
+
+
+== Copyright
+
+Copyright (c) 2010 Johannes J. Schmidt. See LICENSE for details.

data/Rakefile

@@ -1,48 +1,31 @@
 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.summary = %Q{Rest in development core.}
+    gem.description = %Q{Rid is a toolkit to relax in web development. Based on CouchDB you get a distributed, high scaling web application infrastructure with Rid. This is the Rid core.}
     gem.email = "schmidt@netzmerk.com"
-    gem.homepage = "http://jo.github.com/rid/"
+    gem.homepage = "http://rid.github.com/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_dependency "commander", ">= 4.0.3"
+    gem.add_dependency "filander", ">= 0.6.0"
+    gem.add_dependency "rest-client", ">= 1.5.0"
+    gem.add_dependency "json_pure", ">= 1.4.2"
+    gem.add_dependency "activesupport"
+
+    gem.add_dependency "rid-push"
+    gem.add_dependency "rid-init"
+    gem.add_dependency "rid-dd"
+    gem.add_dependency "rid-export"
+
     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
@@ -65,8 +48,10 @@ task :default => :spec
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "rid #{Rid::VERSION}"
+  rdoc.title = "rid #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -0,0 +1 @@
+1.0.2

data/bin/rid

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

data/lib/rid/app.rb

@@ -0,0 +1,49 @@
+module Rid
+  # Holds Application config
+  #
+  class App
+    attr_reader :db_url, :db
+    attr_accessor :root
+
+    # Initialize app with an options object,
+    # which behaves like an open struct.
+    #
+    # Options are:
+    #   root:     specify app root directory
+    #   database: set database name
+    #
+    def initialize(options = OpenStruct.new)
+      @root = options.root
+      @root ||= Dir.pwd
+      @root = Pathname.new(@root)
+
+      @db_url = options.database
+      @db_url ||= read_db_url
+    end
+
+    # Returns an instance of Rid::Database,
+    # configured with db_name.
+    #
+    def db
+      return unless @db_url
+      @db ||= Rid::Database.new(@db_url)
+    end
+
+    # List application documents.
+    # Each entry is a filename.
+    #
+    def documents
+      @documents ||= Dir[root.join("*")].
+        select { |f| File.directory? f }.
+        map { |f| Rid::Document.new :path => f }
+    end
+
+    private
+
+    def read_db_url
+      filename = root.join('_database')
+      File.read(filename).strip
+    rescue Errno::ENOENT
+    end
+  end
+end

data/lib/rid/attachments.rb

@@ -2,9 +2,13 @@ module Rid
   module Attachments
     # Mime type mapping from extensions
     MIME_TYPE_MAPPING = {
+      ".htm" => "text/html",
       ".html" => "text/html",
       ".js" => "text/javascript",
       ".css" => "text/css",
+      ".manifest" => "text/cache-manifest",
+      ".png" => "image/png",
+      ".gif" => "image/gif",
     }
 
 
@@ -44,11 +48,11 @@ module Rid
     # accessor for attachments hash
     #
     def attachments
-      hash["_attachments"] || {}
+      @hash["_attachments"] || {}
     end
 
     def attachments=(value)
-      self.hash["_attachments"] = value
+      @hash["_attachments"] = value
     end
 
 

data/lib/rid/commands.rb

@@ -1,41 +1,63 @@
-if ARGV.empty?
-  ARGV << '--help'
-end
+module Rid
+  # Rid Commands module defines the available Rid commands.
+  # A Rid command is a commander command.
+  # See http://github.com/visionmedia/commander for more information.
+  #
+  module Commands
+    # Returns the version specified in VERSION file at project root.
+    #
+    def self.version
+      versionfile = File.expand_path('../../../VERSION', __FILE__)
+      File.read(versionfile) if File.file?(versionfile)
+    end
+
+    program :name, 'Rid: Rest in development.'
+    program :version, version
+    program :description, <<-STR
+Rid is a toolkit to relax in web development.
+
+    Based on CouchDB you get a distributed,
+    high scaling web application infrastructure with Rid.
+    
+    Rid commands are distributed as RubyGems. Explore more Rid commands via
+    'gem list --remote rid-'
+    
+    Type 'rid help command'
+    to get information about each command.
+    STR
+
+    program :help, 'Author', 'Johannes Jörg Schmidt, TF <schmidt@netzmerk.com>'
+
+    global_option '-q', '--quiet', 'Supress status output'
+
+    global_option '-b BEHAVIOR', '--behavior BEHAVIOR', String, 'Can be skip, pretend and force'
+
+    default_command :help
+
+    # List all installed rid gems, which starts with rid-.
+    #
+    def self.gems
+      Gem.path.
+        map { |p| Dir[File.join(p, 'gems/rid-*')] }.
+        flatten.
+        map { |g| File.basename(g).sub /-(\d+\.)*(\d+)$/, '' }.
+        uniq.
+        sort
+    end
+
+    private
+
+    # require rid gem and do not care if that fails.
+    #
+    def self.require_rid_gem(gem)
+      begin
+        require gem
+      rescue LoadError
+        return
+      end
+    end
 
-HELP_TEXT = <<-EOT
-Usage: rid COMMAND [ARGS]
-
-The most common rid commands are:
- generate    Generate new code (short-cut alias: "g")
- push        Push application code to Couchdb
- pull        Pull latest application code from Couchdb
- routes      List application urls
-
-In addition to those, there are:
- destroy      Undo code generated with "generate"
-
-All commands can be run with -h for more information.
-EOT
-
-
-case ARGV.shift
-when 'g', 'generate'
-  require 'rid/commands/generate'
-when 'destroy'
-  require 'rid/commands/destroy'
-when 'push'
-  require 'rid/commands/push'
-when 'pull'
-  require 'rid/commands/pull'
-when 'routes'
-  require 'rid/commands/routes'
-
-when '--help', '-h'
-  puts HELP_TEXT
-when '--version', '-v'
-  require 'rid/version'
-  puts "Rid #{Rid::VERSION}"
-else
-  puts "Error: Command not recognized"
-  puts HELP_TEXT
+    # actually load all rid gems
+    gems.each { |g| require_rid_gem(g) }
+  end
 end

data/lib/rid/core_ext/hash.rb

@@ -1,5 +1,5 @@
 class Hash
-  DEFAULT_SEPERATOR = '/'
+  DEFAULT_SEPERATOR = '/' unless defined? DEFAULT_SEPERATOR
 
   def flatten(seperator = DEFAULT_SEPERATOR, prefix = nil)
     new_hash = {}

data/lib/rid/database.rb

@@ -0,0 +1,69 @@
+module Rid
+  class Database
+    attr_accessor :name
+
+    # Initialize new Database object by url.
+    #
+    def initialize(name)
+      @name = name
+    end
+
+    # Get document.
+    #
+    def get(doc, options = {})
+      response = RestClient.get(url(doc, options)) rescue nil
+      Rid::Document.new(:json => response.body) if response
+    end
+
+    # Save document.
+    # Creates it, until exists.
+    #
+    def save(doc)
+      # create database unless exists
+      # TODO: make this lazy
+      begin
+        RestClient.put @name, nil
+      rescue RestClient::PreconditionFailed
+        # database already exists
+      end
+      # push document
+      response = RestClient.put(url(doc), doc.to_json)
+      json = JSON.parse(response.body)
+      if json && json["ok"] && json["rev"]
+        doc.rev = json["rev"]
+      end
+      # return response
+      response
+    end
+
+    # Base URL for design document
+    #
+    def base_url(doc)
+      File.join(@name, doc.id)
+    end
+
+    # URL for accessing document
+    # 
+    # Takes an optional options hash
+    # which gets converted to url encoded options
+    # and appended to the documents base url
+    #
+    def url(doc, options = {})
+      base_url(doc) + build_options_string(options)
+    end
+
+    private
+
+    # construct url options string
+    # values are url encoded
+    #
+    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/document.rb

@@ -0,0 +1,99 @@
+require 'erb'
+
+module Rid
+  class Document
+    include Attachments
+
+    attr_accessor :hash, :path
+
+    def initialize(options = {})
+      path = options[:path]
+      path = Pathname.new(path) unless path.nil? || path.is_a?(Pathname)
+      @path = path
+      # build hash from options hash
+      @hash = options[:hash]
+      # build hash from json option
+      self.json = options[:json] if !@hash && options[:json]
+      @hash ||= {}
+    end
+
+    def ==(other)
+      @hash == other.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!(&block)
+      raise 'No path given!' unless @path
+
+      Dir[@path.join '**/*'].
+        map! { |file| Pathname.new file }.
+        delete_if { |f| !f.file? }.
+        flatten.
+        uniq.
+        each do |filename|
+          key = filename.relative_path_from(@path).to_s
+          # strip js extname from javascript files
+          key.sub!(/\.js$/, '') unless key =~ /^_attachments/
+          key.sub!(/\.erb$/, '')
+
+          value = block_given? ? block.call(filename) : read_file(filename)
+          # strip value if its a one-liner
+          value.strip! if value.count("\n") == 1
+          @hash.update_at key, value
+        end
+
+      map_attachments!
+    end
+
+
+    # Returns a JSON string representation of the documents hash
+    #
+    def to_json
+      @hash.to_json
+    end
+
+    # Build the documents hash from a JSON string
+    #
+    def json=(json)
+      @hash = JSON.parse(json)
+    end
+
+    def id
+      @id ||= @hash['_id']
+      @id ||= @path && File.read(@path.join('_id')).strip rescue nil
+    end
+
+    def rev
+      @rev ||= @hash['_rev']
+      @rev ||= @path && File.read(@path.join('_rev')).strip rescue nil
+    end
+
+    def rev=(value)
+      @rev = @hash['_rev'] = value
+      if @path
+        File.open(@path.join('_rev'), "w") { |file| file << value }
+      end
+    end
+
+    private
+
+    def read_file(filename)
+      if File.extname(filename) == '.erb'
+        ERB.new(File.read(filename)).result(binding)
+      else
+        File.read(filename)
+      end
+    end
+  end
+end

data/lib/rid.rb

@@ -1,43 +1,16 @@
+require 'pathname'
+require 'ostruct'
+
 require 'rubygems'
-require 'yaml'
+require 'commander/import'
+require 'filander'
+require 'active_support/inflector'
 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
+require 'rest_client'
+
+require 'rid/core_ext/hash'
+require 'rid/attachments'
+require 'rid/database'
+require 'rid/document'
+require 'rid/app'
+require 'rid/commands'