lattice 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bd35aad62903ddaf3add6cde5a20a9e9f602190c
-  data.tar.gz: 72ba50be9460b11da83f35bb40352d571f63a009
+  metadata.gz: 2a8f7c06d6bea7a244ea71d5015bb3c4246ad8df
+  data.tar.gz: 7e55c3e748cb262fa3c5e1e50ffdb9f4fc5c437b
 SHA512:
-  metadata.gz: 173ccef41e001527e66488f192d3ed69b0374a050397ec3bdf60b846a185eb906d20c6ecdcf54002743c00dfa562bf13b4881f592f4879da411f03a40f64af77
-  data.tar.gz: 6267e585042de5076c09998f6ca4e3ff640d7682b45e9337746576c6d726444a2ea4c98ad35bd44a012e8948e6d5d68e24a2eedb65ce566dd5910780f63d5c1b
+  metadata.gz: 4c53bdb8481350b3f676333f462db567939d1ca53978815ba46d4c16c188fbf3e2d88f4c9af8b513f5d251539a655052c4b2eced8fd2b5a31ea48c2160a95c95
+  data.tar.gz: 2ad9f176a58ff2e07cd196c700c74e53a17eb3e0262acd7642e5bbb4ded0293db63064a8b4460314f962a84a02432ceac4fd38e7520998e0fc5fd25255b118c6

data/.rspec

@@ -1,4 +1,4 @@
 --color
 --format documentation
 --backtrace
---default_path spec
+--order random

data/.travis.yml

@@ -1,3 +1,15 @@
-branches:
-  except:
-    - master
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - ruby-head
+  - jruby-19mode
+  - jruby-head
+  - rbx-19mode
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+
+notifications:
+  irc: "irc.freenode.org#celluloid"

data/CHANGES.md

@@ -1,3 +1,10 @@
+0.2.0 (2013-10-01)
+------------------
+* Create Lattice apps with `lattice new myapp`
+* Launche Lattice apps with `lattice server`
+* Initial Lattice application template/skeleton and generator
+* Initial Lattice command line utility
+
 0.1.0 (2013-09-15)
 ------------------
 * Initial release(-ish)

data/Gemfile

@@ -1,4 +1,4 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gem 'celluloid', github: 'celluloid/celluloid'
 gem 'reel',      github: 'celluloid/reel'
@@ -10,4 +10,6 @@ gemspec
 
 group :development do
   gem 'guard-rspec'
+  gem 'coveralls', require: false
+  gem 'pry'
 end

data/README.md

@@ -1,7 +1,10 @@
 ![Lattice](https://github.com/celluloid/lattice/raw/master/logo.png)
 ==========
+[![Gem Version](https://badge.fury.io/rb/lattice.png)](http://rubygems.org/gems/lattice)
 [![Build Status](https://secure.travis-ci.org/celluloid/lattice.png?branch=master)](http://travis-ci.org/celluloid/lattice)
 [![Code Climate](https://codeclimate.com/github/celluloid/lattice.png)](https://codeclimate.com/github/celluloid/lattice)
+[![Coverage Status](https://coveralls.io/repos/celluloid/lattice/badge.png)](https://coveralls.io/r/celluloid/lattice)
+[![Dependency Status](https://gemnasium.com/celluloid/lattice.png)](https://gemnasium.com/celluloid/lattice)
 
 Lattice is an actor-based web framework for Ruby built on top of
 [Celluloid][celluloid], [Reel][reel], and [Webmachine][webmachine]. Designed
@@ -15,35 +18,79 @@ web application development today.
 
 ## Features
 
-* Resources: the main glue type between Lattice and the web, resources provide
-  an HTTP endpoint for interacting with entities in the system. Resources are
-  in fact a special type of component, one which forms an entry point into the
-  system. Lattice uses [Webmachine](https://github.com/seancribbs/webmachine-ruby)
-  as its resource framework.
+* **Resources**: the main glue type between Lattice and the web, resources
+  provide an HTTP endpoint which interfaces with other entities in the system.
+  Lattice uses [Webmachine][webmachine] as its base for its resource framework.
+
+[webmachine]: https://github.com/seancribbs/webmachine-ruby
 
 ## Vaporware Features (Coming Soon™!)
 
-* Cells: Lattice's go-to domain model object. Cells represent data dependencies
-  of resources, or are resources themselves. Every Cell is a Celluloid actor, 
-  which makes them multithreaded and allows them to compute in parallel (at least
-  on modern Ruby interpreters such as JRuby and Rubinius which don't have a Global
-  Interpreter Lock). They can also do scatter/gather-type I/O operations, making
-  them ideal for querying multiple services in parallel when computing a response.
-  Cells map data dependencies into "slots" which can be used by renderers to compute
-  representations of data within the system, an idea which combines Celluloid's
-  [futures][futures] with an API similar to [decent_exposure][decent_exposure].
+* **Cells**: Lattice's go-to domain model object. Cells represent data
+  dependencies of resources, or are resources themselves. All Cells are
+  Celluloid actors and run in parallel. Cells map data dependencies into "slots"
+  which can be computed in parallel while resources are rendering.
 
 [futures]: https://github.com/celluloid/celluloid/wiki/futures
 [decent_exposure]: https://github.com/voxdolo/decent_exposure
 
-* Renderers: translate data within the system, as fetched by components, into
+* **Renderers**: translate data within the system, as fetched by cells, into
   a requested representation. Renderers handle the specifics of dynamically
   constructing output documents from components. Lattice comes with renderers
   that understand various template languages.
 
-* Sockets: WebSocket connections back to individual clients. Lattice makes it
-  simple to send and receive messages from any part of a distributed system,
-  including background jobs.
+* **WebSockets**: WebSocket connections back to individual clients. Lattice
+  makes it simple to send and receive messages from any part of a distributed
+  system, including background jobs.
+
+Documentation
+-------------
+
+[Please see the Lattice Wiki][wiki] for detailed documentation and usage notes.
+
+[YARD Documentation][yardoc] is also available.
+
+[wiki]: https://github.com/celluloid/lattice/wiki
+[yardoc]: http://rubydoc.info/github/celluloid/lattice/master/frames
+
+Usage
+-----
+
+Lattice provides a Rails-like experience for getting you up-and-running.
+
+First, install the Lattice gem:
+
+```
+$ gem install lattice
+```
+
+Now create a new Lattice application using the CLI tool:
+
+```
+$ lattice new my_app
+```
+
+Unlike Rails we don't automatically run Bundler for you. You'll have to do
+that yourself:
+
+```
+$ cd my_app
+$ bundle
+```
+
+Your new Lattice app is ready to go! Run:
+
+```
+$ lattice server
+```
+
+...to launch your new Lattice app under a local web server. By default the
+appliaction will launch on http://127.0.0.1:3000/. If you visit this URL you
+should see:
+
+```
+Hello, Lattice!
+```
 
 Copyright
 ---------

data/bin/lattice

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'lattice/cli'
+
+Lattice::CLI.start(ARGV)

data/lattice.gemspec

@@ -14,12 +14,15 @@ Gem::Specification.new do |gem|
   gem.name          = 'lattice'
   gem.require_paths = ['lib']
   gem.version       = Lattice::VERSION
+  gem.licenses      = ['MIT']
   
-  gem.add_dependency 'celluloid',     '>= 0.15.1'
-  gem.add_dependency 'reel',          '>= 0.4.0'
-  gem.add_dependency 'webmachine',    '~> 1.2.0'
-  gem.add_dependency 'activesupport', '~> 4.0.0'
+  gem.add_runtime_dependency 'celluloid',     '>= 0.15.1'
+  gem.add_runtime_dependency 'reel',          '>= 0.4.0'
+  gem.add_runtime_dependency 'webmachine',    '~> 1.2.1'
+  gem.add_runtime_dependency 'activesupport', '~> 4.0.0'
+  gem.add_runtime_dependency 'thor',          '>= 0.18.0'
+  gem.add_runtime_dependency 'colorize',      '>= 0.5.0'
   
   gem.add_development_dependency 'rake'
-  gem.add_development_dependency "rspec", ">= 2.7.0"
+  gem.add_development_dependency 'rspec', '>= 2.7.0'
 end

data/lib/lattice.rb

@@ -1,5 +1,37 @@
 require 'lattice/version'
+require 'lattice/application'
 require 'lattice/resource'
+require 'pathname'
 
 module Lattice
+  class << self
+    attr_writer :app, :logger
+
+    def app
+      raise "no application set" unless defined?(@app)
+      @app
+    end
+
+    def root=(path)
+      @root = Pathname.new(path)
+    end
+
+    def root
+      @root || begin
+        pwd = Dir.pwd
+        gemfile = File.join pwd, 'Gemfile'
+
+        # FIXME: Kinda hax :|
+        unless File.read(gemfile)["gem 'lattice'"]
+          raise "couldn't find app in: '#{Dir.pwd}'"
+        end
+
+        pwd
+      end
+    end
+
+    def logger
+      @logger || Celluloid.logger
+    end
+  end
 end

data/lib/lattice/application.rb

@@ -0,0 +1,8 @@
+require 'webmachine'
+
+module Lattice
+  class Application < Webmachine::Application
+    # YAGNI perhaps, but this is the public API to Lattice
+    # We should probably be able to control it
+  end
+end

data/lib/lattice/cli.rb

@@ -0,0 +1,23 @@
+require 'thor'
+
+module Lattice
+  class CLI < Thor
+    desc "create NAME", "create a new Lattice application called NAME"
+    def create(name)
+      require "lattice/generators/app_base"
+
+      app_root = File.expand_path("./#{name}")
+      Generators::AppBase.new(name).generate app_root
+    end
+
+    desc "server", "launch a local Lattice server"
+    def server
+      require "lattice/server"
+
+      Lattice::Server.new("127.0.0.1", 3000, root: Lattice.root).run
+    end
+
+    desc "new NAME", "alias for create"
+    alias new create
+  end
+end

data/lib/lattice/generator.rb

@@ -0,0 +1,68 @@
+require 'colorize'
+require 'erb'
+require 'fileutils'
+
+module Lattice
+  module Generator
+    include FileUtils
+
+    # Create a directory within the application if it doesn't exit
+    def generate_directory(path)
+      if File.directory?(path)
+        ohai "       exist".light_blue + "  #{path}"
+      elsif File.exist?(path)
+         ohai "    conflict".light_red + " #{output_path}"
+         ohai "Template resumes #{output_path} is a directory!"
+      else
+        ohai "      create".light_green + "  #{path}"
+        mkdir_p path
+      end
+    end
+
+    # Render a file template and generate the associated output
+    def generate_file(input_path, output_path)
+      renderer = ERBRenderer.new(input_path, app_const_base: @app_const_base)
+      generated_file = renderer.render
+
+      if File.exist?(output_path)
+        existing_file = File.read(output_path)
+        if generated_file == existing_file
+          ohai "   identical".light_blue + "  #{output_path}"
+        else
+          ohai "    conflict".light_red + " #{output_path}"
+          overwrite = prompt("Overwrite #{output_path}? [yn] ")
+          if overwrite == "y"
+            ohai "       force".light_yellow + "  #{output_path}"
+            File.open(output_path, "w") { |f| f << generated_file }
+          else
+            ohai "        skip".light_yellow + "  #{output_path}"
+          end
+        end
+      else
+        directory = File.dirname(output_path) + "/"
+        generate_directory(directory) unless File.directory?(directory)
+        ohai "      create".light_green + "  #{output_path}"
+        File.open(output_path, "w") { |f| f << generated_file }
+      end
+    end
+
+    # Tell the user something
+    def ohai(message)
+      puts message
+    end
+
+    # Renders ERB file templates for generators
+    class ERBRenderer
+      def initialize(template, options)
+        @template = template
+        @options  = options
+      end
+
+      def render
+        ERB.new(File.read(@template)).result(binding)
+      end
+
+      def app_const_base; @options[:app_const_base]; end
+    end
+  end
+end

data/lib/lattice/generators/app_base.rb

@@ -0,0 +1,44 @@
+require 'lattice/generator'
+require 'active_support/inflector'
+
+module Lattice
+  module Generators
+    class AppBase
+      include Generator
+
+      DEFAULT_APP_TEMPLATE = File.expand_path("../../../../template", __FILE__)
+
+      def initialize(name, options = {})
+        @name = name.to_s
+        @app_const_base = @name.camelize
+
+        @template_path = options[:template_path] || DEFAULT_APP_TEMPLATE
+      end
+
+      # Generate a Lattice application at the given path
+      def generate(app_root)
+        app_root = File.expand_path(app_root)
+
+        # Is this a brand spankin' new app?
+        new_app = !File.exists?(app_root)
+
+        template_paths = Dir[File.join(@template_path, '**', '*')]
+        raise "No templates found. Something's wrong? :(" if template_paths.empty?
+
+        template_paths.each do |input_path|
+          relative_path = input_path.sub(@template_path, '')
+          output_path   = File.join(app_root, relative_path)
+
+          if File.directory?(input_path)
+            generate_directory(output_path)
+          else
+            generate_file(input_path, output_path)
+          end
+        end
+
+        ohai "NOTE: Don't forget to: ".light_yellow +
+             "cd #{app_root} && bundle".light_white
+      end
+    end
+  end
+end

data/lib/lattice/request_logger.rb

@@ -0,0 +1,27 @@
+module Lattice
+  class RequestLogger
+    def call(*args)
+      handle_event Webmachine::Events::InstrumentedEvent.new(*args)
+    end
+
+    def handle_event(event)
+      request  = event.payload[:request]
+      resource = event.payload[:resource]
+      code     = event.payload[:code]
+      uri      = URI(request.uri)
+
+      # Translate extended HTTP verbs via the magical query parameter
+      if request.method == "POST" && request.query['_method']
+        method = request.query['_method']
+      else
+        method = request.method
+      end
+
+      Lattice.logger.info "\"%s %s\" %d %.1fms (%s)" % [
+        method, uri.path, code, event.duration, resource
+      ]
+    end
+  end
+
+  Webmachine::Events.subscribe('wm.dispatch', RequestLogger.new)
+end

data/lib/lattice/resource.rb

@@ -1,8 +1,13 @@
 require 'webmachine'
 require 'active_support/core_ext/class/attribute'
 
+# For Celluloid::Logger
+require 'celluloid'
+
 module Lattice
   class Resource < Webmachine::Resource
+    include Celluloid::Logger
+
     class_attribute :allowed_methods
     class_attribute :content_types_accepted
     class_attribute :content_types_provided
@@ -59,5 +64,9 @@ module Lattice
       return encodings if encodings && !encodings.empty?
       super
     end
+
+    def handle_exception(ex)
+      crash "#{self.class} crashed!", ex
+    end
   end
-end
+end

data/lib/lattice/server.rb

@@ -0,0 +1,33 @@
+require 'reel'
+require 'lattice'
+require 'lattice/request_logger'
+
+module Lattice
+  class Server
+    def initialize(host, port, options = {})
+      @host, @port = host, port
+      @root = options[:root] || Lattice.root
+      load
+    end
+
+    def load
+      $LOAD_PATH << @root
+      require 'config/application'
+    end
+
+    def run
+      app = Lattice.app
+
+      app.configure do |config|
+        config.ip      = @host
+        config.port    = @port
+        config.adapter = :Reel
+      end
+
+      Lattice.logger.info "A Reel good HTTP server! (Codename \"#{::Reel::CODENAME}\")"
+      Lattice.logger.info "Listening on http://#{@host}:#{@port}"
+
+      app.run
+    end
+  end
+end

data/lib/lattice/version.rb

@@ -1,3 +1,3 @@
 module Lattice
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/lattice/application_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe Lattice::Application do
+  it "sure could use some specs!" do
+    pending "write some!"
+  end
+end

data/spec/lattice/cli_spec.rb

@@ -0,0 +1,8 @@
+require 'spec_helper'
+require 'lattice/cli'
+
+describe Lattice::CLI do
+  it "sure could use some specs!" do
+    pending "it doesn't have any :("
+  end
+end

data/spec/lattice/generators/app_base_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'lattice/generators/app_base'
+
+describe Lattice::Generators::AppBase do
+  let(:example_app)  { "exemplifier" }
+  let(:example_path) { File.join(TMPDIR, example_app) }
+
+  before(:each) { FileUtils.rm_r(example_path) if File.exists?(example_path) }
+
+  it "generates Lattice template applications" do
+    generator = described_class.new(example_app)
+    generator.generate example_path
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,7 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'bundler/setup'
-require 'lattice'
+require 'lattice'
+
+TMPDIR = File.expand_path("../../tmp", __FILE__)

data/template/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gem 'lattice',    github: 'celluloid/lattice'
+gem 'webmachine', github: 'seancribbs/webmachine-ruby'
+gem 'webmachine-test'

data/template/README.md

@@ -0,0 +1,41 @@
+# <%= app_const_base %>
+
+A [Lattice][lattice] application created by a brave individual! Rails may be a
+more conservative choice, but clearly it pissed off the brave individual behind
+this app, and so here we are.
+
+You may want to tweak this README to add more specific documentation about this
+app. Or you don't have to, whatever. But perhaps you want to know more about
+using Lattice, so here we go:
+
+## Documentation
+
+[Please see the Lattice Wiki][wiki] for detailed documentation and usage notes.
+
+[YARD Documentation][yardoc] is also available.
+
+[wiki]: https://github.com/celluloid/lattice/wiki
+[yardoc]: http://rubydoc.info/github/celluloid/lattice/master/frames
+
+## Adding Resources
+
+Resources are the heart of any Lattice application. They represent "RESTful"
+HTTP endpoints that respond in a fully deterministic manner depending on their
+state.
+
+Unfortunately, there's no resource generator at present! You will need to view
+the [Lattice Wiki documentation on Resources][resources] to find out information
+about the Resource API and how to add new resources to your application.
+
+[resources]: https://github.com/celluloid/lattice/wiki/Resources
+
+## Starting the app
+
+To launch the application, run:
+
+```
+$ lattice server
+```
+
+By default the appliaction will launch on http://127.0.0.1:3000/
+

data/template/app/resources/home.rb

@@ -0,0 +1,7 @@
+module Resources
+  class Home < Lattice::Resource
+    def to_html
+      "Hello, Lattice!"
+    end
+  end
+end

data/template/config/application.rb

@@ -0,0 +1,14 @@
+require File.expand_path("../boot", __FILE__)
+
+# Require your resources here
+require 'resources/home'
+
+module <%= app_const_base %>
+  Application = Lattice::Application.new do |app|
+    app.routes do
+      add ['*'], Resources::Home
+    end
+  end
+end
+
+Lattice.app = <%= app_const_base %>::Application

data/template/config/boot.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+gemfile = ENV['BUNDLE_GEMFILE'] || File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(gemfile)
+
+Lattice.root = Pathname.new(File.expand_path('../..', __FILE__))
+$LOAD_PATH.unshift Lattice.root.join('app').to_s

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lattice
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-15 00:00:00.000000000 Z
+date: 2013-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,34 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.18.0
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +125,8 @@ dependencies:
 description: A concurrent realtime web framework for Ruby
 email:
 - tony.arcieri@gmail.com
-executables: []
+executables:
+- lattice
 extensions: []
 extra_rdoc_files: []
 files:
@@ -106,20 +135,37 @@ files:
 - .travis.yml
 - CHANGES.md
 - Gemfile
+- Gemfile.lock
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/lattice
 - lattice.gemspec
 - lib/lattice.rb
+- lib/lattice/application.rb
+- lib/lattice/cli.rb
+- lib/lattice/generator.rb
+- lib/lattice/generators/app_base.rb
+- lib/lattice/request_logger.rb
 - lib/lattice/resource.rb
+- lib/lattice/server.rb
 - lib/lattice/version.rb
 - logo.png
+- spec/lattice/application_spec.rb
+- spec/lattice/cli_spec.rb
+- spec/lattice/generators/app_base_spec.rb
 - spec/lattice/resource_spec.rb
 - spec/spec_helper.rb
 - tasks/rspec.task
+- template/Gemfile
+- template/README.md
+- template/app/resources/home.rb
+- template/config/application.rb
+- template/config/boot.rb
 homepage: https://github.com/tarcieri/lattice
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -143,5 +189,8 @@ specification_version: 4
 summary: Lattice is a pervasively multithreaded web framework for Ruby which makes
   building realtime web applications with WebSockets simple and fun
 test_files:
+- spec/lattice/application_spec.rb
+- spec/lattice/cli_spec.rb
+- spec/lattice/generators/app_base_spec.rb
 - spec/lattice/resource_spec.rb
 - spec/spec_helper.rb