lattice 0.0.0 → 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bd35aad62903ddaf3add6cde5a20a9e9f602190c
+  data.tar.gz: 72ba50be9460b11da83f35bb40352d571f63a009
+SHA512:
+  metadata.gz: 173ccef41e001527e66488f192d3ed69b0374a050397ec3bdf60b846a185eb906d20c6ecdcf54002743c00dfa562bf13b4881f592f4879da411f03a40f64af77
+  data.tar.gz: 6267e585042de5076c09998f6ca4e3ff640d7682b45e9337746576c6d726444a2ea4c98ad35bd44a012e8948e6d5d68e24a2eedb65ce566dd5910780f63d5c1b

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+branches:
+  except:
+    - master

data/CHANGES.md

@@ -0,0 +1,3 @@
+0.1.0 (2013-09-15)
+------------------
+* Initial release(-ish)

data/Gemfile

@@ -1,4 +1,13 @@
 source 'http://rubygems.org'
 
+gem 'celluloid', github: 'celluloid/celluloid'
+gem 'reel',      github: 'celluloid/reel'
+
+gem 'webmachine', github: 'seancribbs/webmachine-ruby'
+
 # Specify your gem's dependencies in lattice.gemspec
 gemspec
+
+group :development do
+  gem 'guard-rspec'
+end

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

data/README.md

@@ -1,23 +1,40 @@
-Lattice
-=======
+![Lattice](https://github.com/celluloid/lattice/raw/master/logo.png)
+==========
+[![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)
 
-Lattice is a pervasively multithreaded web framework for Ruby which makes
-building realtime web applications with WebSockets simple and fun. It's
-built on the following primitives:
+Lattice is an actor-based web framework for Ruby built on top of
+[Celluloid][celluloid], [Reel][reel], and [Webmachine][webmachine]. Designed
+from the ground up for realtime applications, end-to-end streaming, and
+Websockets, Lattice provides solutions to some of the biggest pain points in
+web application development today.
+
+[celluloid]: https://github.com/celluloid/celluloid/
+[reel]: https://github.com/celluloid/reel
+[webmachine]: https://github.com/seancribbs/webmachine-ruby/
+
+## 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.
+  system. Lattice uses [Webmachine](https://github.com/seancribbs/webmachine-ruby)
+  as its resource framework.
+
+## 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].
 
-* Components: data dependencies of resources (or resources themselves).
-  Components are inherently multithreaded and computed in parallel. Somewhat
-  analogous to "models" in frameworks like Rails, components are the natural
-  abstraction Lattice provides for subdividing the work needed to compute a
-  representation of a particular resource, and are where things like database
-  interactions and additional queries to external services should take place.
-  Components map data dependencies into "slots" which can be used by renderers
-  to compute representations of data within the system.
+[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
   a requested representation. Renderers handle the specifics of dynamically
@@ -31,4 +48,5 @@ built on the following primitives:
 Copyright
 ---------
 
-Copyright © 2011 Tony Arcieri. See LICENSE.txt for further details.
+Copyright © 2013 Tony Arcieri. Distributed under the MIT license.
+See LICENSE.txt for further details.

data/Rakefile

@@ -1,2 +1,5 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+Dir["tasks/**/*.task"].each { |task| load task }
+
+task :default => :spec

data/lattice.gemspec

@@ -15,11 +15,10 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Lattice::VERSION
   
-  gem.add_dependency 'celluloid'
-  gem.add_dependency 'dcell'
-  gem.add_dependency 'cramp'
-  gem.add_dependency 'webmachine'
-  gem.add_dependency 'activesupport'
+  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_development_dependency 'rake'
   gem.add_development_dependency "rspec", ">= 2.7.0"

data/lib/lattice.rb

@@ -1,5 +1,5 @@
-require "lattice/version"
+require 'lattice/version'
+require 'lattice/resource'
 
 module Lattice
-  # Your code goes here...
 end

data/lib/lattice/resource.rb

@@ -0,0 +1,63 @@
+require 'webmachine'
+require 'active_support/core_ext/class/attribute'
+
+module Lattice
+  class Resource < Webmachine::Resource
+    class_attribute :allowed_methods
+    class_attribute :content_types_accepted
+    class_attribute :content_types_provided
+    class_attribute :encodings_provided
+
+    class << self
+      def allow_method(*methods)
+        self.allowed_methods ||= []
+        self.allowed_methods += methods.map(&:to_s).map(&:upcase)
+      end
+      alias allow allow_method
+
+      def accept_content_type(content_types)
+        content_types.each do |key, value|
+          self.content_types_accepted ||= []
+          content_types_accepted << [key, value]
+        end
+      end
+      alias accept accept_content_type
+
+      def provide_content_type(content_types)
+        content_types.each do |key, value|
+          self.content_types_provided ||= []
+          content_types_provided << [key, value]
+        end
+      end
+
+      def provide_encoding(encodings)
+        self.encodings_provided ||= {}
+        encodings_provided.merge!(encodings)
+      end
+    end
+
+    def allowed_methods
+      methods = self.class.allowed_methods
+      return methods if methods && !methods.empty?
+      super
+    end
+
+    def content_types_accepted
+      types = self.class.content_types_accepted
+      return types if types && !types.empty?
+      super
+    end
+
+    def content_types_provided
+      types = self.class.content_types_provided
+      return types if types && !types.empty?
+      super
+    end
+
+    def encodings_provided
+      encodings = self.class.encodings_provided
+      return encodings if encodings && !encodings.empty?
+      super
+    end
+  end
+end

data/lib/lattice/version.rb

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

data/spec/lattice/resource_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+
+describe Lattice::Resource do
+  context "allowable methods" do
+    it "can be declared with `allow_method'" do
+      klass = Class.new(described_class) do
+        allow_method :get
+        allow_method :post
+      end
+
+      klass.allowed_methods.should eq %W[GET POST]
+    end
+
+    it "can be declared with `allow'" do
+      klass = Class.new(described_class) do
+        allow :get
+        allow :post
+      end
+
+      klass.allowed_methods.should eq %W[GET POST]
+    end
+  end
+
+  context "acceptable content types" do
+    it "can be declared with `accept_content_type'" do
+      klass = Class.new(described_class) do
+        accept_content_type "application/json" => :to_json
+        accept_content_type "text/xml" => :to_xml
+      end
+
+      klass.content_types_accepted.should eq [
+        ["application/json", :to_json],
+        ["text/xml", :to_xml]
+      ]
+    end
+
+    it "can be declared with `accept'" do
+      klass = Class.new(described_class) do
+        accept "application/json" => :to_json
+        accept "text/xml" => :to_xml
+      end
+
+      klass.content_types_accepted.should eq [
+        ["application/json", :to_json],
+        ["text/xml", :to_xml]
+      ]
+    end
+  end
+
+  context "provided content types" do
+    it "can be declared with `provide_content_type'" do
+      klass = Class.new(described_class) do
+        provide_content_type "application/json" => :to_json
+        provide_content_type "text/xml" => :to_xml
+      end
+
+      klass.content_types_provided.should eq [
+        ["application/json", :to_json],
+        ["text/xml", :to_xml]
+      ]
+    end
+  end
+
+  context "provided encodings" do
+    it "can be declared with `provide_encoding'" do
+      klass = Class.new(described_class) do
+        provide_encoding 'gzip' => :encode_gzip
+        provide_encoding 'identity' => :encode_identity
+      end
+
+      klass.encodings_provided.should eq({
+        'gzip'     => :encode_gzip,
+        'identity' => :encode_identity
+      })
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'bundler/setup'
+require 'lattice'

data/tasks/rspec.task

@@ -0,0 +1,7 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+RSpec::Core::RakeTask.new(:rcov) do |task|
+  task.rcov = true
+end

metadata

@@ -1,93 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: lattice
 version: !ruby/object:Gem::Version
-  version: 0.0.0
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-11 00:00:00.000000000 Z
+date: 2013-09-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &70140403517900 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.15.1
   type: :runtime
   prerelease: false
-  version_requirements: *70140403517900
-- !ruby/object:Gem::Dependency
-  name: dcell
-  requirement: &70140403517400 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70140403517400
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
-  name: cramp
-  requirement: &70140403516800 !ruby/object:Gem::Requirement
-    none: false
+  name: reel
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.4.0
   type: :runtime
   prerelease: false
-  version_requirements: *70140403516800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: webmachine
-  requirement: &70140403515820 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.2.0
   type: :runtime
   prerelease: false
-  version_requirements: *70140403515820
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70140403515400 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 4.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70140403515400
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70140403514980 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70140403514980
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70140403514280 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.7.0
   type: :development
   prerelease: false
-  version_requirements: *70140403514280
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
 description: A concurrent realtime web framework for Ruby
 email:
 - tony.arcieri@gmail.com
@@ -96,41 +102,46 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
+- CHANGES.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - lattice.gemspec
 - lib/lattice.rb
+- lib/lattice/resource.rb
 - lib/lattice/version.rb
-- spec/fixtures/application/Appfile
-- spec/fixtures/application/README.md
+- logo.png
+- spec/lattice/resource_spec.rb
+- spec/spec_helper.rb
+- tasks/rspec.task
 homepage: https://github.com/tarcieri/lattice
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+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/fixtures/application/Appfile
-- spec/fixtures/application/README.md
-has_rdoc: 
+- spec/lattice/resource_spec.rb
+- spec/spec_helper.rb

data/spec/fixtures/application/Appfile

@@ -1,2 +0,0 @@
-class ExampleApplication < Lattice::Application
-end

data/spec/fixtures/application/README.md

@@ -1,4 +0,0 @@
-Example
-=======
-
-This is an example application built with Lattice