hyper-react 0.10.0

data/.travis.yml

@@ -0,0 +1,29 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby-19mode
+before_script:
+  - phantomjs --version
+script:
+  - bundle exec rake test_app
+  - bundle exec rake
+gemfile:
+  - gemfiles/opal_0.8_react_13.gemfile
+  - gemfiles/opal_0.8_react_14.gemfile
+  - gemfiles/opal_0.8_react_15.gemfile
+  - gemfiles/opal_0.9_react_13.gemfile
+  - gemfiles/opal_0.9_react_14.gemfile
+  - gemfiles/opal_0.9_react_15.gemfile
+
+# These two setup seems to run indefinitely long
+# further investigation required.
+matrix:
+  exclude:
+  - rvm: jruby-19mode
+    gemfile: gemfiles/opal_0.9_react_13.gemfile
+  - rvm: jruby-19mode
+    gemfile: gemfiles/opal_0.9_react_14.gemfile
+  - rvm: jruby-19mode
+    gemfile: gemfiles/opal_0.9_react_15.gemfile

data/Appraisals

@@ -0,0 +1,20 @@
+opal_versions = ['0.8', '0.9']
+react_versions_map = {
+  '13' => '~> 1.3.3',
+  '14' => '~> 1.6.2',
+  '15' => '~> 1.8.2'
+}
+opal_rails_versions_map = {
+  '0.8' => '~> 0.8.1',
+  '0.9' => '~> 0.9.0',
+}
+
+opal_versions.each do |opal_v|
+  react_versions_map.each do |react_v, react_rails_v|
+    appraise "opal-#{opal_v}-react-#{react_v}" do
+      gem 'opal', "~> #{opal_v}.0"
+      gem 'opal-rails', opal_rails_versions_map[opal_v]
+      gem 'react-rails', react_rails_v, require: false
+    end
+  end
+end

data/CHANGELOG.md

@@ -0,0 +1,93 @@
+# Change Log
+
+All notable changes to this project will be documented in this file starting with v0.8.6.
+This project *tries* to adhere to [Semantic Versioning](http://semver.org/), even before v1.0.
+
+Changes are grouped as follows:
+- **Added** for new features.
+- **Changed** for changes in existing functionality.
+- **Deprecated** for once-stable features to be removed in upcoming releases.
+- **Removed** for deprecated features removed in this release.
+- **Fixed** for any bug fixes.
+- **Security** to invite users to upgrade in case of vulnerabilities.
+
+<!--
+Whitespace conventions:
+- 4 spaces before ## titles
+- 2 spaces before ### titles
+- 1 spaces before normal text
+ -->
+
+## [0.10.0] - 2016-10-30
+
+### Changed
+
+- This gem is now renamed to `hyper-react`, see [UPGRADING](UPGRADING.md) for details.
+
+### Fixed
+
+- ReactJS functional stateless component could not be imported from `NativeLibrary`. Note that functional component is only supported in React v14+.  (#162)
+- Prerender log got accumulated between reqeusts. (#176)
+
+## [0.9.0] - 2016-10-19
+
+### Added
+
+- `react/react-source` is the suggested way to include ReactJS sources now. Simply require `react/react-source` immediately before the `require "reactrb"` in your Opal code will make it work.
+
+### Deprecated
+
+- `react-latest` & `react-v1x` is deprecated. Use `react/react-source` instead.
+
+### Removed
+
+- `opal-browser` is removed from runtime dependency. (#133)  You will have to add `gem 'opal-browser'` to your gemfile (recommended) or remove all references to opal-browser from your manifest files.
+
+### Fixed
+
+- `$window#on` in `opal-jquery` is broken. (#166)
+- `Element#render` trigger unnecessary re-mounts when called multiple times. (#170)
+- Gets rid of react warnings about updating state during render (#155)
+- Multiple HAML classes (i.e. div.foo.bar) was not working (regression introduced in 0.8.8)
+- Don't send nil (null) to form components as the value string (#157)
+- Process `params` (props) correctly when using `Element#on` or `Element#render` (#158)
+- Deprecate shallow param compare (#156)
+
+
+## [0.8.8] - 2016-07-13
+
+### Added
+
+- More helpful error messages on render failures (#152)
+- `Element#on('<my_event_name>')` subscribes to `my_event_name` (#153)
+
+### Changed
+
+- `Element#on(:event)` subscribes to `on_event` for reactrb components and `onEvent` for native components. (#153)
+
+### Deprecated
+
+- `Element#on(:event)` subscription to `_onEvent` is deprecated. Once you have changed params named `_on...` to `on_...` you can `require 'reactrb/new-event-name-convention.rb'` to avoid spurious react warning messages. (#153)
+
+
+### Fixed
+
+- The `Element['#container'].render...` method generates a spurious react error (#154)
+
+
+
+
+## [0.8.7] - 2016-07-08
+
+
+### Fixed
+
+- Opal 0.10.x compatibility
+
+
+## [0.8.6] - 2016-06-30
+
+
+### Fixed
+
+- Method missing within a component was being reported as `incorrect const name` (#151)

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+group :development do
+  gem "appraisal"
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2015 Yi-Cheng Chang (http://github.com/zetachang)
+
+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.md

@@ -0,0 +1,121 @@
+# hyper-react
+
+[![Join the chat at https://gitter.im/reactrb/chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/reactrb/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![Build Status](https://travis-ci.org/ruby-hyperloop/reactrb.svg?branch=master)](https://travis-ci.org/reactrb/reactrb)
+[![Code Climate](https://codeclimate.com/github/reactrb/reactrb/badges/gpa.svg)](https://codeclimate.com/github/reactrb/reactrb)
+[![Gem Version](https://badge.fury.io/rb/reactrb.svg)](https://badge.fury.io/rb/reactrb)
+
+**hyper-react is an [Opal Ruby](http://opalrb.org) wrapper of
+[React.js library](https://facebook.github.io/react)**.
+
+It lets you write reactive UI components, with Ruby's elegance using the tried
+and true React.js engine. :heart:
+
+Visit [ruby-hyperloop.io](http://ruby-hyperloop.io) for the full story.
+
+### Important: `react.rb`, `reactive-ruby` and `reactrb` gems are **deprecated**. See [**UPGRADING**](UPGRADING.md) for details.
+
+## Installation
+
+Install the gem, or load the js library
+
+1. Add `gem 'hyper-react'` to your **Gemfile**
+2. Or `gem install hyper-react`
+3. Or install (or load via cdn) from [reactrb-express.js](http://github.com/ruby-hyperloop/reactrb-express)
+
+For gem installation it is highly recommended to read the [getting started](http://ruby-hyperloop.io/get_started/) and [installation](http://ruby-hyperloop.io/installation/) guides at [ruby-hyperloop.io.](http://ruby-hyperloop.io)
+
+## Quick Overview
+
+A component is a plain ruby class with a `#render` method defined.
+
+```ruby
+class HelloMessage
+  def render
+    React.create_element("div") { "Hello World!" }
+  end
+end
+
+puts React.render_to_static_markup(React.create_element(HelloMessage))
+
+# => '<div>Hello World!</div>'
+```
+
+### React::Component
+
+You can simply include `React::Component` to get the power of a complete DSL to generate html markup, event handlers and it also provides a full set of class macros to define states, parameters, and lifecycle callbacks.
+
+As events occur, components update their state, which causes them to rerender, and perhaps pass new parameters to lower level components, thus causing them to rerender.
+
+```ruby
+class HelloWorld < React::Component::Base
+  param :time, type: Time
+  render do
+    p do
+      span { "Hello, " }
+      input(type: :text, placeholder: "Your Name Here")
+      span { "! It is #{params.time}"}
+    end
+  end
+end
+
+every(1) do
+  Element["#example"].render do
+    HelloWorld(time: Time.now)
+  end
+end
+```
+
+hyper-react components are *isomorphic* (or *univeral*) meaning they can run on the server as well as the client.
+
+hyper-react integrates well with Rails, Sinatra, and simple static sites, and can be added to existing web pages very easily.
+
+Under the hood the actual work is effeciently done by the [React.js](https://facebook.github.io/react) engine.
+
+
+## Why ?
+
++ *Single Language:*  Use Ruby everywhere, no JS, markup languages, or JSX
++ *Powerful DSL:* Describe HTML and event handlers with a minimum of fuss
++ *Ruby Goodness:* Use all the features of Ruby to create reusable, maintainable UI code
++ *React Simplicity:* Nothing is taken away from the React.js model
++ *Enhanced Features:* Enhanced parameter and state management and other new features
++ *Plays well with Others:* Works with other frameworks, React.js components, Rails, Sinatra and static web pages
+
+## Problems, Questions, Issues
+
++ [Stack Overflow](http://stackoverflow.com/questions/tagged/react.rb) tag `react.rb` for specific problems.
++ [Gitter.im](https://gitter.im/reactrb/chat) for general questions, discussion, and interactive help.
++ [Github Issues](https://github.com/reactrb/reactrb/issues) for bugs, feature enhancements, etc.
+
+
+## Roadmap
+
+Version 0.10.x **will not be** 100% backward compatible with 0.3.0 (`react.rb`) or 0.7.x (`reactive-ruby`).
+
+Please let us know either at [Gitter.im](https://gitter.im/reactrb/chat) or [via an issue](https://github.com/reactrb/reactrb/issues) if you have specific concerns with the upgrade from 0.3.0 to 0.10.x.
+
+## Developing
+
+`git clone` the project.
+
+To play with some live examples, refer to https://github.com/ruby-hyperloop/reactrb-examples.
+
+Note that these are very simple examples, for the purpose of showing how to configure the gem in various server environments.  For more examples and information see [ruby-hyperloop.io.](http://ruby-hyperloop.io)
+
+## Testing
+
+1. Run `bundle exec rake test_app` to generate a dummy test app.
+2. `bundle exec appraisal install` to generate separate gemfiles for different environments.
+2. `bundle exec appraisal opal-0.9-react-15 rake` to run test for opal-0.9 & react-v0.15.
+
+## Contributions
+
+This project is still in early stage, so discussion, bug reports and PRs are
+really welcome :wink:.
+
+
+## License
+
+In short, hyper-react is available under the MIT license. See the LICENSE file for
+more info.

data/Rakefile

@@ -0,0 +1,33 @@
+require 'bundler'
+Bundler.require
+Bundler::GemHelper.install_tasks
+
+# Store the BUNDLE_GEMFILE env, since rake or rspec seems to clean it
+# while invoking task.
+ENV['REAL_BUNDLE_GEMFILE'] = ENV['BUNDLE_GEMFILE']
+
+require 'rspec/core/rake_task'
+require 'opal/rspec/rake_task'
+
+RSpec::Core::RakeTask.new('ruby:rspec')
+
+Opal::RSpec::RakeTask.new('opal:rspec') do |s, task|
+  s.append_path 'spec/vendor'
+  s.index_path = 'spec/index.html.erb'
+  task.timeout = 80000 if task
+end
+
+task :test do
+  Rake::Task['ruby:rspec'].invoke
+  Rake::Task['opal:rspec'].invoke
+end
+
+require 'generators/reactive_ruby/test_app/test_app_generator'
+desc "Generates a dummy app for testing"
+task :test_app do
+  ReactiveRuby::TestAppGenerator.start
+  puts "Setting up test app database..."
+  system("bundle exec rake db:drop db:create db:migrate > #{File::NULL}")
+end
+
+task default: [ :test ]

data/UPGRADING.md

@@ -0,0 +1,24 @@
+## Upgrading to hyper-react from Reactrb
+
+Follow these steps to upgrade:
+
+1. Replace `reactrb` with `hyper-react` both in **Gemfile** and any `require`s in your code.
+2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'hyper-react'`. This will use the copy of React.js source from `react-rails` gem.
+
+## Upgrading to Reactrb
+
+The original gem `react.rb` was superceeded by `reactive-ruby`, which has had over 15,000 downloads.  This name has now been superceeded by `reactrb` (see #144 for detailed discussion on why.)
+
+Going forward the name `reactrb` will be used consistently as the organization name, the gem name, the domain name, the twitter handle, etc.
+
+The first initial version of `reactrb` is 0.8.x.
+
+It is very unlikely that there will be any more releases of the `reactive-ruby` gem, so users should upgrade to `reactrb`.
+
+There are no syntactic or semantic breaking changes between `reactrb` v 0.8.x and
+previous versions, however the `reactrb` gem does *not* include the react-js source as previous versions did.  This allows you to pick the react js source compatible with other gems and react js components you may be using.
+
+Follow these steps to upgrade:
+
+1. Replace `reactive-ruby` with `reactrb` both in **Gemfile** and any `require`s in your code.
+2. To include the React.js source, the suggested way is to add `require 'react/react-source'` before `require 'reactrb'`. This will use the copy of React.js source from `react-rails` gem.

data/component-name-lookup.md

@@ -0,0 +1,145 @@
+#### Notes on how component names are looked up
+
+Given:
+
+```ruby
+
+class Blat < React::Component::Base
+
+  render do
+    Bar()      
+    Foo::Bar()
+  end
+
+end
+
+class Bar < React::Component::Base
+end
+
+module Foo
+
+  class Bar < React::Component::Base
+
+    render do
+      Blat()
+      Baz()
+    end
+  end
+
+  class Baz < React::Component::Base
+  end
+
+end
+```
+
+The problem is that method lookup is different than constant lookup.  We can prove it by running this code:
+
+```ruby
+def try_it(test, &block)
+  puts "trying #{test}"
+  result = yield
+  puts "success#{': '+result.to_s if result}"
+rescue Exception => e
+  puts "failed: #{e}"
+ensure
+  puts "---------------------------------"
+end
+
+module Boom
+
+  Bar = 12
+
+  def self.Bar
+    puts "   Boom::Bar says hi"
+  end
+
+  class Baz
+    def doit
+      try_it("Bar()") { Bar() }
+      try_it("Boom::Bar()") {Boom::Bar()}
+      try_it("Bar") { Bar }
+      try_it("Boom::Bar") { Boom::Bar }
+    end
+  end
+end
+
+
+
+Boom::Baz.new.doit
+```
+
+which prints:
+
+```text
+trying Bar()
+failed: Bar: undefined method `Bar' for #<Boom::Baz:0x774>
+---------------------------------
+trying Boom::Bar()
+   Boom::Bar says hi
+success
+---------------------------------
+trying Bar
+success: 12
+---------------------------------
+trying Boom::Bar
+success: 12
+---------------------------------
+```
+
+[try-it](http://opalrb.org/try/?code:def%20try_it(test%2C%20%26block)%0A%20%20puts%20%22trying%20%23%7Btest%7D%22%0A%20%20result%20%3D%20yield%0A%20%20puts%20%22success%23%7B%27%3A%20%27%2Bresult.to_s%20if%20result%7D%22%0Arescue%20Exception%20%3D%3E%20e%0A%20%20puts%20%22failed%3A%20%23%7Be%7D%22%0Aensure%0A%20%20puts%20%22---------------------------------%22%0Aend%0A%0Amodule%20Boom%0A%20%20%0A%20%20Bar%20%3D%2012%0A%20%20%0A%20%20def%20self.Bar%0A%20%20%20%20puts%20%22%20%20%20Boom%3A%3ABar%20says%20hi%22%0A%20%20end%0A%0A%20%20class%20Baz%0A%20%20%20%20def%20doit%0A%20%20%20%20%20%20try_it(%22Bar()%22)%20%7B%20Bar()%20%7D%0A%20%20%20%20%20%20try_it(%22Boom%3A%3ABar()%22)%20%7BBoom%3A%3ABar()%7D%0A%20%20%20%20%20%20try_it(%22Bar%22)%20%7B%20Bar%20%7D%0A%20%20%20%20%20%20try_it(%22Boom%3A%3ABar%22)%20%7B%20Boom%3A%3ABar%20%7D%0A%20%20%20%20end%0A%20%20end%0Aend%0A%20%20%0A%0A%0ABoom%3A%3ABaz.new.doit)
+
+
+What we need to do is:
+
+1. when defining a component class `Foo`, also define in the same scope that Foo is being defined a method `self.Foo` that will accept Foo's params and child block, and render it.
+
+2. As long as a name is qualified with at least one scope (i.e. `ModName::Foo()`) everything will work out, but if we say just `Foo()` then the only way I believe out of this is to handle it via method_missing, and let method_missing do a const_get on the method_name (which will return the class) and then render that component.
+
+#### details
+
+To define `self.Foo` in the same scope level as the class `Foo`, we need code like this:
+
+```ruby
+def register_component_dsl_method(component)
+  split_name = component.name && component.name.split('::')
+  return unless split_name && split_name.length > 2
+  component_name = split_name.last
+  parent = split_name.inject([Module]) { |nesting, next_const| nesting + [nesting.last.const_get(next_const)] }[-2]
+  class << parent
+    define_method component_name do |*args, &block|
+      React::RenderingContext.render(name, *args, &block)
+    end
+    define_method "#{component_name}_as_node" do |*args, &block|
+      React::Component.deprecation_warning("..._as_node is deprecated.  Render component and then use the .node method instead")
+      send(component_name, *args, &block).node
+    end
+  end
+end
+
+module React
+  module Component
+    def self.included(base)
+      ...
+      register_component_dsl_method(base.name)
+    end
+  end
+end
+```
+
+The component's method_missing function will look like this:
+
+```ruby
+def method_missing(name, *args, &block)
+  if name =~ /_as_node$/
+    React::Component.deprecation_warning("..._as_node is deprecated.  Render component and then use the .node method instead")
+    method_missing(name.gsub(/_as_node$/,""), *args, &block).node
+  else
+    component = const_get name if defined? name
+    React::RenderingContext.render(nil, component, *args, &block)
+  end
+end
+```
+
+### other related issues
+
+The Kernel#p method conflicts with the <p> tag.   However the p method can be invoked on any object so we are going to go ahead and use it, and deprecate the para method.