RubyGems - opal-vienna - Versions diffs - 0.7.0 - Mend

opal-vienna 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (45) hide show

checksums.yaml +7 -0
data/.gitignore +3 -0
data/.travis.yml +8 -0
data/Gemfile +7 -0
data/README.md +294 -0
data/Rakefile +7 -0
data/config.ru +8 -0
data/lib/opal-vienna.rb +1 -0
data/lib/opal/vienna.rb +7 -0
data/lib/opal/vienna/version.rb +5 -0
data/opal-vienna.gemspec +26 -0
data/opal/vienna.rb +5 -0
data/opal/vienna/adapters/base.rb +45 -0
data/opal/vienna/adapters/local.rb +50 -0
data/opal/vienna/adapters/rest.rb +97 -0
data/opal/vienna/eventable.rb +35 -0
data/opal/vienna/history_router.rb +44 -0
data/opal/vienna/model.rb +222 -0
data/opal/vienna/observable.rb +90 -0
data/opal/vienna/observable_array.rb +73 -0
data/opal/vienna/output_buffer.rb +13 -0
data/opal/vienna/record_array.rb +31 -0
data/opal/vienna/router.rb +85 -0
data/opal/vienna/template_view.rb +41 -0
data/opal/vienna/view.rb +93 -0
data/spec/eventable_spec.rb +94 -0
data/spec/history_router_spec.rb +47 -0
data/spec/model/accessing_attributes_spec.rb +29 -0
data/spec/model/as_json_spec.rb +28 -0
data/spec/model/attribute_spec.rb +22 -0
data/spec/model/initialize_spec.rb +42 -0
data/spec/model/load_spec.rb +17 -0
data/spec/model/persistence_spec.rb +84 -0
data/spec/model_spec.rb +84 -0
data/spec/observable_array_spec.rb +130 -0
data/spec/observable_spec.rb +116 -0
data/spec/output_buffer_spec.rb +37 -0
data/spec/record_array_spec.rb +50 -0
data/spec/route_spec.rb +89 -0
data/spec/router_spec.rb +103 -0
data/spec/spec_helper.rb +53 -0
data/spec/template_view_spec.rb +47 -0
data/spec/vendor/jquery.js +2 -0
data/spec/view_spec.rb +78 -0
metadata +181 -0

checksums.yaml ADDED

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b09d0611f88239ef252d838f98660fe7369dfb2e
+  data.tar.gz: 61de2285db362bd22937096c888a702888ebcf66
+SHA512:
+  metadata.gz: f6a03da4dbd2644efa67ec614b32aa24ada741c9f811c827319684539452b5dee68e3c17acbcb62e903578171710e30b51e7d2b729cb3a594a0153f6fb2c1624
+  data.tar.gz: 4ca6629997042994b3487cecddcf918e77b67ebfdf8b8423731283760c22b7c2ca389fa844b26fd92a970e2d8a6e84c20b8f3c12637acd4b2a3455659aa406f0

data/.gitignore ADDED

@@ -0,0 +1,3 @@
+.DS_Store
+/build
+Gemfile.lock

data/.travis.yml ADDED

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+notifications:
+  irc: "irc.freenode.org#opal"

data/Gemfile ADDED

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+gemspec
+gem 'opal'
+gem 'opal-jquery',        :github => 'opal/opal-jquery'
+gem 'opal-activesupport', :github => 'opal/opal-activesupport'
+gem 'opal-rspec',         '0.4.0.beta4'

data/README.md ADDED

@@ -0,0 +1,294 @@
+# Vienna: Client side MVC framework for Opal
+[![Build Status](https://travis-ci.org/opal/vienna.png?branch=master)](https://travis-ci.org/opal/vienna)
+Until a better README is out (shame on us) you can take a look at
+the [Opal implementation](https://github.com/opal/opal-todos)
+of [TodoMVC](http://todomvc.com).
+## Installation
+Add vienna to your ```Gemfile``` with a reference to the Github source.
+Note: The vienna hosted on rubygems.org is a different project.
+```ruby
+gem 'opal-vienna'
+```
+If you're compiling opal in a static application, make sure to require bundler first.
+```ruby
+require 'bundler'
+Bundler.require
+```
+## Model
+Client side models.
+```ruby
+class Book < Vienna::Model
+  attributes :title, :author
+end
+book = Book.new(title: 'My awesome book', author: 'Bob')
+book.title = 'Bob: A story of awesome'
+```
+### Attributes
+Attributes can be defined on subclasses using `attributes`. This simply defines
+a getter/setter method using `attr_accessor`. You can override either method as
+expected:
+```ruby
+class Book < Vienna::Model
+  attributes :title, :release_date
+  # If date is a string, then we need to parse it
+  def release_date=(date)
+    date = Date.parse(date) if String === date
+    @release_date = date
+  end
+end
+book = Book.new(:release_date => '2013-1-10')
+book.release_date
+# => #<Date: 2013-1-10>
+```
+## Views
+`Vienna::View` is a simple wrapper class around a dom element representing a
+view of some model (or models). A view's `element` is dynamically created when
+first accessed. `View.element` can be used to specify a dom selector to find
+the view in the dom.
+Assuming the given html:
+```html
+<body>
+  <div id="foo">
+    <span>Hi</span>
+  </div>
+</body>
+```
+We can create our view like so:
+```ruby
+class MyView < Vienna::View
+  element '#foo'
+end
+MyView.new.element
+# => #<Element: [<div id="foo">]>
+```
+A real, existing, element can also be passed into the class method:
+```ruby
+class MyView < Vienna::View
+  # Instances of this view will have the document as an element
+  element Document
+end
+```
+Views can have parents. If a child view is created, then the dom selector is
+only searched inside the parents element.
+### Customizing elements
+A `View` will render as a div tag, by default, with no classes (unless an
+element selector is defined). Both these can be overriden inside your view
+subclass.
+```ruby
+class NavigationView < Vienna::View
+  def tag_name
+    :ul
+  end
+  def class_name
+    "navbar navbar-blue"
+  end
+end
+```
+### Rendering views
+Views have a placeholder `render` method, that doesnt do anything by default.
+This is the place to put rendering logic.
+```ruby
+class MyView < Vienna::View
+  def render
+    element.html = 'Welcome to my rubyicious page'
+  end
+end
+view = MyView.new
+view.render
+view.element
+# => '<div>Welcome to my rubyicious page</div>'
+```
+### Listening for events
+When an element is created, defined events can be added to it. When a view is
+destroyed, these event handlers are then removed.
+```ruby
+class ButtonView < Vienna::View
+  on :click do |evt|
+    puts "clicked on button"
+  end
+  def tag_name
+    :button
+  end
+end
+```
+For complex views, you can provide an optional css selector to scope the events:
+```ruby
+class NavigationView < Vienna::View
+  on :click, 'ul.navbar li' do |evt|
+    puts "clicked: #{evt.target}"
+  end
+  on :mouseover, 'ul.navbar li.selected', :handle_mouseover
+  def handle_mouseover(evt)
+    # ...
+  end
+end
+```
+As you can see, you can specify a method to handle events instead of a block.
+### Customizing element creation
+You can also override `create_element` if you wish to have any custom element
+creation behaviour.
+For example, a subview that is created from a parent element
+```ruby
+class NavigationView < Vienna::View
+  def initialize(parent, selector)
+    @parent, @selector = parent, selector
+  end
+  def create_element
+    @parent.find(@selector)
+  end
+end
+```
+Assuming we have the html:
+```html
+<div id="header">
+  <img id="logo" src="logo.png" />
+  <ul class="navigation">
+    <li>Homepage</li>
+  </ul>
+</div>
+```
+We can use the navigation view like this:
+```ruby
+@header = Element.find '#header'
+nav_view = NavigationView.new @header, '.navigation'
+nav_view.element
+# => [<ul class="navigation">]
+```
+## Router
+`Vienna::Router` is a simple router that watches for hashchange events.
+```ruby
+router = Vienna::Router.new
+router.route("/users") do
+  puts "need to show all users"
+end
+router.route("/users/:id") do |params|
+  puts "need to show user: #{ params[:id] }"
+end
+# visit "example.com/#/users"
+# visit "example.com/#/users/3"
+# visit "example.com/#/users/5"
+# => "need to show all users"
+# => need to show user: 3
+# => need to show user: 5
+```
+## Observable
+Adds KVO style attribute observing.
+```ruby
+class MyObject
+  include Vienna::Observable
+  attr_accessor :name
+  attr_reader :age
+  def age=(age)
+    @age = age + 10
+  end
+end
+obj = MyObject.new
+obj.add_observer(:name) { |new_val| puts "name changed to #{new_val}" }
+obj.add_observer(:age) { |new_age| puts "age changed to #{new_age}" }
+obj.name = "bob"
+obj.age = 42
+# => "name changed to bob"
+# => "age changed to 52"
+```
+## Observable Arrays
+```ruby
+class MyArray
+  include Vienna::ObservableArray
+end
+array = MyArray.new
+array.add_observer(:content) { |content| puts "content is now #{content}" }
+array.add_observer(:size) { |size| puts "size is now #{size}" }
+array << :foo
+array << :bar
+# => content is now [:foo]
+# => size is now 1
+# => content is now [:bar]
+# => size is now 2
+```
+#### Todo
+* Support older browsers which do not support onhashchange.
+* Support not-hash style routes with HTML5 routing.
+## License
+MIT

data/Rakefile ADDED

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+require 'opal/activesupport'
+require 'opal/rspec/rake_task'
+Opal::RSpec::RakeTask.new(:default)

data/config.ru ADDED

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.require
+run Opal::Server.new { |s|
+  s.main = 'opal/rspec/sprockets_runner'
+  s.append_path 'spec'
+  s.debug = false
+}

data/lib/opal-vienna.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'opal/vienna'

data/lib/opal/vienna.rb ADDED

@@ -0,0 +1,7 @@
+require 'opal'
+require 'opal-jquery'
+require 'opal-activesupport'
+require 'opal/vienna/version'
+# Just register our opal code path with opal build tools
+Opal.append_path File.expand_path('../../../opal', __FILE__)

data/lib/opal/vienna/version.rb ADDED

@@ -0,0 +1,5 @@
+module Opal
+  module Vienna
+    VERSION = '0.7.0'
+  end
+end

data/opal-vienna.gemspec ADDED

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.expand_path('../lib', __FILE__)
+require 'opal/vienna/version'
+Gem::Specification.new do |s|
+  s.name         = 'opal-vienna'
+  s.version      = Opal::Vienna::VERSION
+  s.author       = 'Adam Beynon'
+  s.email        = 'adam@adambeynon.com'
+  s.homepage     = 'http://opalrb.org'
+  s.summary      = 'Client side MVC framework for Opal'
+  s.description  = 'Client side MVC framework for Opal'
+  s.license      = 'MIT'
+  s.files          = `git ls-files`.split("\n")
+  s.executables    = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.test_files     = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths  = ['lib']
+  s.add_dependency 'opal', ['>= 0.5.0', '< 1.0.0']
+  s.add_dependency 'opal-jquery'
+  s.add_dependency 'opal-activesupport'
+  s.add_development_dependency 'opal-rspec', '>= 0.2.1'
+  s.add_development_dependency 'rake'
+end

data/opal/vienna.rb ADDED

@@ -0,0 +1,5 @@
+require 'vienna/eventable'
+require 'vienna/model'
+require 'vienna/adapters/base'
+require 'vienna/view'
+require 'vienna/router'

data/opal/vienna/adapters/base.rb ADDED

@@ -0,0 +1,45 @@
+module Vienna
+  class << self
+    attr_accessor :adapter
+  end
+  # An adapter is responsible for fetching and saving records from
+  # some endpoint. This base class acts as an interface which subclasses
+  # should develop. Adapters can be set on a per-model basis, or as an
+  # adapter for all models. Example adapter subclasses are RESTAdapter
+  # and LocalAdapter. A fixtures adapter is also provided for testing
+  # purposes.
+  class Adapter
+    def find(record, id, &block)
+      implement "find"
+    end
+    def load(record, id, &block)
+      implement "load"
+    end
+    def create_record(record)
+      implement "create_record"
+    end
+    def update_record(record)
+      implement "update_record"
+    end
+    def save_record(record)
+      implement "save_record"
+    end
+    def delete_record(record)
+      implement "delete_record"
+    end
+    def fetch
+      implement "fetch"
+    end
+    def implement(method)
+      raise NoMethodError, "Adapter subclass should implement `#{method}'"
+    end
+  end
+end

data/opal/vienna/adapters/local.rb ADDED

@@ -0,0 +1,50 @@
+require 'vienna/adapters/base'
+module Vienna
+  # Adapter using LocalStorage as a backend
+  class LocalAdapter < Adapter
+    def initialize
+      @storage = $global.localStorage
+    end
+    def create_record(record, &block)
+      record.id = self.unique_id
+      record.did_create
+      sync_models(record.class)
+      block.call(record) if block
+    end
+    def update_record(record, &block)
+      record.did_update
+      sync_models(record.class)
+      block.call(record) if block
+    end
+    def delete_record(record, &block)
+      record.did_destroy
+      sync_models record.class
+      block.call(record) if block
+    end
+    def find_all(klass, &block)
+      if data = @storage.getItem(klass.name)
+        models = JSON.parse(data).map { |m| klass.load(m) }
+        block.call(models) if block
+      end
+    end
+    # sync all records in given class to localstorage, now!
+    def sync_models(klass)
+      name = klass.name
+      @storage.setItem name, klass.all.to_json
+    end
+    # generate a new unique id.. just use timestamp for now
+    def unique_id
+      (Time.now.to_f * 1000).to_s
+    end
+  end
+end