rwr-react_router 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b7b462334865192fbb07b80e8621277f714c2288
+  data.tar.gz: 43242f975b90f04020d90dcec54c89b1e5a8c416
+SHA512:
+  metadata.gz: ee235dca96f5b32928e23f6aeb0145a9d6728cb1749a26094aff66a29cd9004e921dcbe4afbab45ba3bd817b13a17cdb8a8503c88a3f196ba5c6bc07a1fead0d
+  data.tar.gz: 00a6283039ef9f1ec8802a465b7e1b4a9116750615241d08d8f1ba33ef0eae8b1f07238390c053a84e38a0b82adf3b02838384af8b871c27cf51b4a9fb9431cb

data/.babelrc

@@ -0,0 +1,3 @@
+{
+  "presets": ["es2015", "react"]
+}

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/js/lib/
+
+node_modules
+rwr-react_router-*.gem

data/.npmignore

@@ -0,0 +1 @@
+js/src/

data/.travis.yml

@@ -0,0 +1,33 @@
+branches:
+  except:
+    - docs
+
+language: ruby
+
+cache:
+  bundler: true
+  directories:
+  - node_modules
+
+matrix:
+  include:
+    - rvm: 2.2.4
+      gemfile: spec/rails4_dummy_app/Gemfile
+      env: TEST_SUITE=rails4
+    - rvm: 2.2.4
+      gemfile: Gemfile
+      env: TEST_SUITE=gem
+    - rvm: 2.2.4
+      env: TEST_SUITE=node
+
+before_script:
+  - npm install -g npm@^2.0
+  - npm install -g webpack@^1.12.1
+  - bundle exec rake setup:$TEST_SUITE
+  - 'export CHROME_BIN=chromium-browser'
+  - "export DISPLAY=:99.0" # Setup display for selenium driver
+  - "sh -e /etc/init.d/xvfb start"
+  - sleep 3 # give xvfb some time to start
+
+script:
+  - bundle exec rake test:$TEST_SUITE

data/CHANGELOG.md

@@ -0,0 +1 @@
+## UNRELEASED

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rwr-react_router.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Rafał Gawlik
+
+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,56 @@
+rwr-react_router
+====
+
+[react-router](https://github.com/reactjs/react-router) integration plugin for [react_webpack_rails](https://github.com/netguru/react_webpack_rails).
+
+This integration makes it possible to render previously created router in rails view.
+
+## Setup
+* Add `rwr-react_router` to your Gemfile:
+
+ ```
+ gem 'rwr-react_router'
+ ```
+
+* Install rwr-react-router package:
+```
+$ npm install --save rwr-react-router
+```
+
+## Usage
+* Make sure that you have `react-router` installed.
+* Import RWRReactRouter in your index.js file:
+```js
+import RWRReactRouter from 'rwr-react-router';
+```
+
+* Register one of your routers:
+```js
+RWRReactRouter.register('MyRouter', MyRouter);
+```
+
+* In chosen view, render your router:
+```erb
+<%= react_router('MyRouter') %>
+```
+
+## Contributing
+## Issues
+
+Found a bug in rwr-react_router? Open an issue on [GitHub Issues](https://github.com/netguru/rwr-react_router/issues).
+
+## Pull requests
+
+Interested in contributing to rwr-react_router? That's great, and thank you for your interest!
+
+After checking out the repo, run `bundle exec rake setup:all` to install every environment dependencies.
+
+To get your contributions accepted, make sure:
+
+* All the tests pass. Run `bundle exec rake test:all`.
+* Any new code paths you've added are covered by tests.
+* Describe your changes in pull request (what it adds, how to migrate from previous version etc.)
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,49 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+namespace :test do
+  desc 'Run all tests'
+  task all: [:node, :gem, :rails4] do
+    puts 'Finished all tests, yay!'
+  end
+
+  desc 'Run node package tests'
+  task :node do
+    sh %Q(npm test)
+  end
+
+  desc 'Run gem tests'
+  task :gem do
+    sh %Q(bundle exec rspec spec/rwr-react_router.rb)
+  end
+  desc 'Run rspec for rails4 application'
+  task :rails4 do
+    Bundler.with_clean_env do
+      sh %Q(cd spec/rails4_dummy_app && npm run build && bundle exec rspec)
+    end
+  end
+end
+
+task default: 'test:all'
+
+namespace :setup do
+  desc 'Prepare every environment'
+  task all: [:node, :gem, :rails4] do
+    puts 'Prepared all, yay!'
+  end
+
+  desc 'Prepare node module dependencies'
+  task :node do
+    sh %Q(npm install)
+  end
+
+  desc 'Prepare gem dependencies'
+  task :gem do
+    sh %Q(bundle install)
+  end
+
+  desc 'Prepare rails4 test app dependencies'
+  task :rails4 do
+    sh %Q(npm install && cd spec/rails4_dummy_app && npm install && bundle install)
+  end
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rwr-react_router"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,5 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle exec rake setup:all

data/js/.eslintrc

@@ -0,0 +1,12 @@
+{
+  "extends": "airbnb",
+  "globals": {
+    "__RWR_ENV__": true
+  },
+  "env": {
+    "mocha": true
+  },
+  "rules": {
+    func-names: 0
+  }
+}

data/js/src/index.js

@@ -0,0 +1,51 @@
+import ReactDOM from 'react-dom';
+import VERSION from './version';
+
+class ReactRouterIntegration {
+  constructor() {
+    this.version = VERSION;
+    this.routers = {};
+    this.enabled = false;
+    this.register = this.register.bind(this);
+    this.get = this.get.bind(this);
+    this.render = this.render.bind(this);
+  }
+
+  register(name, route) {
+    this.routers[name] = route;
+  }
+
+  get(name) {
+    return this.routers[name];
+  }
+
+  render(name, node) {
+    if (this.enabled === true) {
+      throw new Error(
+        `Error when rendering ${name}\n
+        \trenderRouter: can't render more than one router on the same page.`
+      );
+    }
+    this.enabled = true;
+    ReactDOM.render(this.get(name), node);
+  }
+
+  unmount(node) {
+    ReactDOM.unmountComponentAtNode(node);
+    this.enabled = false;
+  }
+
+  get integrationWrapper() {
+    return {
+      mount: function _mount(node, payload) {
+        this.render(payload.name, node);
+      }.bind(this),
+
+      unmount: function _unmount(node) {
+        this.unmount(node);
+      }.bind(this),
+    };
+  }
+}
+
+export default new ReactRouterIntegration;

data/js/src/version.js

@@ -0,0 +1 @@
+export default '0.1.0';

data/js/test/index.js

@@ -0,0 +1,139 @@
+import expect, { spyOn } from 'expect';
+import ReactDOM from 'react-dom';
+import subject from '../src/index';
+
+const HelloRouter = {};
+
+describe('RWRReactRouter', function () {
+  afterEach(function () {
+    subject.routers = {};
+    subject.enabled = false;
+  });
+
+  describe('.version', function () {
+    it('is present', function () {
+      expect(subject.version).toNotEqual(undefined);
+    });
+  });
+
+  describe('.constructor', function () {
+    it('intializes empty components dictionary', function () {
+      expect(subject.routers).toEqual({});
+    });
+
+    it('by default sets router presence flag to false', function () {
+      expect(subject.enabled).toBe(false);
+    });
+  });
+
+  describe('#register', function () {
+    it('adds router to the routers storage', function () {
+      subject.register('HelloRouter', HelloRouter);
+      expect(subject.routers.HelloRouter).toBe(HelloRouter);
+    });
+  });
+
+  describe('#get', function () {
+    it('returns route by name', function () {
+      subject.register('HelloRouter', HelloRouter);
+      expect(subject.get('HelloRouter')).toBe(HelloRouter);
+    });
+
+    it('returns undefined if route is not found', function () {
+      expect(subject.get('HelloRouter')).toBe(undefined);
+    });
+  });
+
+  describe('#render', function () {
+    beforeEach(function () {
+      subject.register('HelloRouter', HelloRouter);
+    });
+
+    context('when router is present', function () {
+      it('throws an error', function () {
+        expect(function () {
+          subject.render('HelloRouter', { node: 'someNode' });
+        })
+        .withContext(subject.enabled = true)
+        .toThrow(/Error when rendering HelloRouter/);
+      });
+    });
+
+    context('when router does not exist', function () {
+      let ReactDOMSpy;
+      const node = { nodeType: 1, nodeName: 'DIV' };
+      beforeEach(function () {
+        ReactDOMSpy = spyOn(ReactDOM, 'render');
+      });
+
+      afterEach(function () {
+        expect.restoreSpies();
+      });
+
+      it('sets router presence flag to true', function () {
+        subject.render('HelloRouter', node);
+
+        expect(subject.enabled).toBe(true);
+      });
+
+      it('calls ReactDOM renderer once', function () {
+        subject.render('HelloRouter', { nodeType: 1, nodeName: 'DIV' });
+
+        expect(ReactDOMSpy.calls.length).toEqual(1);
+        expect(ReactDOMSpy).toHaveBeenCalledWith(HelloRouter, { nodeType: 1, nodeName: 'DIV' });
+      });
+    });
+  });
+
+  describe('#unmount', function () {
+    let ReactDOMSpy;
+    beforeEach(function () {
+      ReactDOMSpy = spyOn(ReactDOM, 'unmountComponentAtNode');
+    });
+
+    afterEach(function () {
+      expect.restoreSpies();
+    });
+
+    it('unmounts router component at specified node', function () {
+      subject.unmount({ node: 'someNode' });
+
+      expect(ReactDOMSpy.calls.length).toEqual(1);
+      expect(ReactDOMSpy).toHaveBeenCalledWith({ node: 'someNode' });
+    });
+
+    it('allows to add new router', function () {
+      subject.unmount({ node: 'someNode' });
+      expect(subject.enabled).toBe(false);
+    });
+  });
+
+  describe('#integrationWrapper', function () {
+    const node = { nodeType: 1, nodeName: 'DIV' };
+
+    describe('function mount', function () {
+      it('calls renderComponent', function () {
+        const mountSpy = spyOn(subject, 'render');
+
+        const payload = { name: 'routerName' };
+        subject.integrationWrapper.mount(node, payload);
+
+        expect(mountSpy.calls.length).toEqual(1);
+        expect(mountSpy).toHaveBeenCalledWith(
+          'routerName',
+          { nodeType: 1, nodeName: 'DIV' }
+        );
+      });
+    });
+
+    describe('function unmount', function () {
+      it('calls unmountComponent', function () {
+        const unmountSpy = spyOn(subject, 'unmount');
+        subject.integrationWrapper.unmount(node);
+
+        expect(unmountSpy.calls.length).toEqual(1);
+        expect(unmountSpy).toHaveBeenCalledWith({ nodeType: 1, nodeName: 'DIV' });
+      });
+    });
+  });
+});

data/lib/react_webpack_rails/react_router_integration/engine.rb

@@ -0,0 +1,6 @@
+module ReactWebpackRails
+  module ReactRouterIntegration
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/react_webpack_rails/react_router_integration/railtie.rb

@@ -0,0 +1,11 @@
+require 'react_webpack_rails/react_router_integration/view_helpers'
+
+module ReactWebpackRails
+  module ReactRouterIntegration
+    class Railtie < ::Rails::Railtie
+      initializer 'react_webpack_rails.react_router_helpers.view_helpers' do
+        ActionView::Base.send :include, ViewHelpers
+      end
+    end
+  end
+end

data/lib/react_webpack_rails/react_router_integration/version.rb

@@ -0,0 +1,5 @@
+module ReactWebpackRails
+  module ReactRouterIntegration
+    VERSION = '0.1.0'
+  end
+end

data/lib/react_webpack_rails/react_router_integration/view_helpers.rb

@@ -0,0 +1,9 @@
+module ReactWebpackRails
+  module ReactRouterIntegration
+    module ViewHelpers
+      def react_router(name)
+        react_element('react-router', name: name)
+      end
+    end
+  end
+end

data/lib/rwr-react_router.rb

@@ -0,0 +1,4 @@
+require 'react_webpack_rails/react_router_integration/version'
+
+require 'react_webpack_rails/react_router_integration/engine' if defined?(Rails)
+require 'react_webpack_rails/react_router_integration/railtie' if defined?(Rails)

data/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "rwr-react-router",
+  "version": "0.1.0",
+  "description": "",
+  "main": "js/lib/index.js",
+  "files": [
+    "js/lib"
+  ],
+  "scripts": {
+    "compile": "babel --presets es2015 -d js/lib/ js/src/",
+    "prepublish": "npm run compile",
+    "test": "mocha js/test --ui bdd --recursive --require babel-core/register"
+  },
+  "repository": {
+    "type": "",
+    "url": ""
+  },
+  "keywords": [
+  ],
+  "author": "",
+  "license": "",
+  "bugs": {
+    "url": ""
+  },
+  "homepage": "",
+  "peerDependencies": {
+    "react": "^0.14.0",
+    "react-dom": "^0.14.0"
+  },
+  "dependencies": {
+    "react-webpack-rails": "^0.1.0"
+  },
+  "devDependencies": {
+    "babel-cli": "^6.4.0",
+    "babel-core": "^6.4.0",
+    "babel-preset-es2015": "^6.3.0",
+    "babel-preset-react": "^6.3.0",
+    "eslint": "^1.10.3",
+    "eslint-config-airbnb": "^3.1.0",
+    "eslint-plugin-react": "^3.15.0",
+    "expect": "^1.13.4",
+    "history": "^1.17.0",
+    "mocha": "^2.3.4"
+  }
+}

data/rwr-react_router.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'react_webpack_rails/react_router_integration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rwr-react_router'
+  spec.version       = ReactWebpackRails::ReactRouterIntegration::VERSION
+  spec.authors       = ['Rafał Gawlik']
+  spec.email         = ['react@netguru.co']
+
+  spec.summary       = 'React router integration for react_webpack_rails'
+  spec.description   = ''
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+
+  spec.add_dependency 'react_webpack_rails', '>= 0.1.0'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: rwr-react_router
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafał Gawlik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: react_webpack_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+description: ''
+email:
+- react@netguru.co
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".babelrc"
+- ".gitignore"
+- ".npmignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- js/.eslintrc
+- js/src/index.js
+- js/src/version.js
+- js/test/index.js
+- lib/react_webpack_rails/react_router_integration/engine.rb
+- lib/react_webpack_rails/react_router_integration/railtie.rb
+- lib/react_webpack_rails/react_router_integration/version.rb
+- lib/react_webpack_rails/react_router_integration/view_helpers.rb
+- lib/rwr-react_router.rb
+- package.json
+- rwr-react_router.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: React router integration for react_webpack_rails
+test_files: []