redux_rails 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47499912ebfcb4b6458a809851ce58e051413625
-  data.tar.gz: b15c4bf9d2b82456e7a0d7a34a49e8533ae748d1
+  metadata.gz: '0458dcd23ed778b5909241bbc905235c77016732'
+  data.tar.gz: 56dd6816d30383dc66564fdc15eafc238740e943
 SHA512:
-  metadata.gz: 79a79ef291e0c10c954b67273b19632cf43f45282bca22a11b23b6e8e930d80483a69b7326e7d9d99cf7dec6c1ceadfe91d37b2b9d696264c843b0a410ac9af4
-  data.tar.gz: 5112f1d49cc2409d7eade0bcc242f72afb533848c861be0fdbc2d3c45ae47cc5a23c89eb40e3947dca2b54701f64b504049d73328d4005f85250f18a49b3a1cc
+  metadata.gz: 9447cf2697c8019fc1fdd5997548a6b2fb5fbdf67477e5807c155f96647f01ef1c87befaa42e7014c4aab52c04f0da8ea3574ce3b54f0f7bfcdb7f11e68a23f8
+  data.tar.gz: 1aafd80b82473c258bfbdbd8469bc2fb0e0a212bd743375ae454eda11b7a9c0c05c293fab6720706797aac6638aca837da2e6b46887598cf5eae47294c4248ea

data/README.md

@@ -1,13 +1,14 @@
 # ReduxRails
 
 ## Highlights
-- install, component and container generator
+- install, pack, component and container generator
 - creates a new pack tag for each `rails g redux_rails:install #{your_app_name}` command and installs the necessary lines to manifest.json. Allowing you to have several seperate React apps inside of a single rails project.
 - install component and container folders in any folder location from the command line with the necessary import/export/require lines.
 - react-router-dom
 - redux-devtools-extension
 
 ### Install generator
+- Installs the following dependencies `yarn add react-redux redux redux-devtools-extension react-router-dom react-router-redux history`
 - Installs a new #{your_app_name}.jsx file in app/javascript/packs with additional Redux setup options commented out for modifications.
 ###### *if you leave #{your_app_name} blank.  file, component and container names will default to 'app'*
 - Links it to public/packs/manifest.json
@@ -30,6 +31,9 @@
 * app/javascript/src/#{your_app_name}/containers/app/constants.js,
 * app/javascript/src/#{your_app_name}/containers/app/appReducer.js
 
+### Pack generator
+#### Runs the Install generator without re-installing the javascript dependencies again
+
 ### Component generator
 #### Created folder/files
 * app/javascript/src/#{your_app_name}/components/app/#{your_component_name},
@@ -78,7 +82,7 @@ config.x.webpacker[:dev_server_host] = "http://127.0.0.1:8080"
 
 To create the packs/manifest.json run:
 
-    $ ./bin/webpack-dev-server --host 127.0.0.1
+    $ bin/webpack-dev-server --host 127.0.0.1
 
 At this point, Rails has created a javascript friendly app for you. To render the sample react component rails creates for you follow these steps. Or to start using the redux_rails gem skip down to Usage.
 
@@ -109,29 +113,33 @@ Hello React!
 ## Usage
 
 ### Install generator
-Once your rails app is setup with the webpack=react option and the redux-rails gem is installed execute:
+###### *only run this once! If you wish to create additional pack files run `rails generate redux_rails:pack #{pack_name}`*
+Once your rails app is setup with the webpack=react option and the redux-rails gem is installed and your `config/environments/development.rb` is updated execute:
 ###### *if you leave #{your_app_name} blank file, component and container names will default to 'app'*
 
     $ rails generate redux_rails:install #{your_app_name}
 
 This will install the following files:
-```
-app/javascript/src,
-app/javascript/src/#{your_app_name}/reducer.js, "this is for your combineReducer"
-
-app/javascript/src/#{your_app_name}/components,
-app/javascript/src/#{your_app_name}/components/#{your_app_name},
-app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.js,
-app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.scss
-
-app/javascript/src/#{your_app_name}/containers,
-app/javascript/src/#{your_app_name}/containers/#{your_app_name},
-app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}.js,
-app/javascript/src/#{your_app_name}/containers/#{your_app_name}/action.js,
-app/javascript/src/#{your_app_name}/containers/#{your_app_name}/actionTypes.js,
-app/javascript/src/#{your_app_name}/containers/#{your_app_name}/constants.js,
-app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}Reducer.js
-```
+###### src section
+- `app/javascript/src`
+- `app/javascript/src/#{your_app_name}/reducer.js` *"this is for your combineReducer"*
+###### components section
+- `app/javascript/src/#{your_app_name}/components`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.js`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.scss`
+###### containers section
+- `app/javascript/src/#{your_app_name}/containers`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/action.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/actionTypes.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/constants.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}Reducer.js`
+
+and adds and installs these dependencies to your package.json file:
+
+`react-redux` `redux` `redux-devtools-extension` `react-router-dom` `react-router-redux` `history`
 
 Once the install generator is finished:
 1. add the following pack_tags to the file you want the react component to be rendered in
@@ -144,10 +152,36 @@ Once the install generator is finished:
 #{your_app_name} component!
 find me in find me in app/javascript/src/#{your_app_name}/components/#{your_app_name}#{your_app_name}.js
 ```
+### Pack generator
+The Pack generator takes a single name argument
+###### *if you leave #{your_app_name} blank file, component and container names will default to 'app'*
+To create a new Pack file run:
+
+    $ rails generate pack #{your_app_name}
+
+This will generate a new React app inside of the `app/javascript/src` folder. Including a new `pack/#{your_app_name}.jsx` file and links to `public/packs/manifest.json`. Includes the following folder and files:
+
+###### src section
+- `app/javascript/src`
+- `app/javascript/src/#{your_app_name}/reducer.js` *"this is for your combineReducer"*
+###### components section
+- `app/javascript/src/#{your_app_name}/components`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.js`
+- `app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.scss`
+###### containers section
+- `app/javascript/src/#{your_app_name}/containers`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/action.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/actionTypes.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/constants.js`
+- `app/javascript/src/#{your_app_name}/containers/#{your_app_name}/#{your_app_name}Reducer.js`
+
 
 ### Component generator
 The Component generator takes two arguments (the new Component name and the desired install location)
-###### *if you leave #{your_app_name} blank file, component and container names will default to 'app'*
+###### *if you leave #{your_app_name} or #{your_component_name} blank file, component and container names will default to 'app'*
 To create a new component run:
 
     $ rails generate component  #{your_component_name} #{your_app_name}
@@ -159,7 +193,7 @@ This will generate a new folder inside of your components folder with the follow
 
 ### Container generator
 The Container generator takes two arguments (the new Container name and the desired install location)
-###### *if you leave #{your_app_name} blank file, component and container names will default to 'app'*
+###### *if you leave #{your_app_name} or #{your_container_name} blank file, component and container names will default to 'app'*
 To create a new container run:
 
     $ rails generate container  #{your_container_name} #{your_app_name}

data/lib/generators/pack/pack_generator.rb

@@ -0,0 +1,129 @@
+class PackGenerator < Rails::Generators::NamedBase
+	source_root File.expand_path('../templates', __FILE__)
+  argument :name, :type => :string, :default => "app"
+
+	def create_src_directory
+	  empty_directory("app/javascript/src")
+	  empty_directory("app/javascript/src/#{name}")
+	end
+
+	def create_reducer_base_file
+		create_file "app/javascript/src/#{name}/reducer.js",
+"import { combineReducers } from 'redux'
+import #{name}Reducer from './containers/#{name}/#{name}Reducer.js'
+
+const rootReducer = combineReducers({
+#{name}Reducer
+})
+
+export default rootReducer"
+	end
+
+	def create_component_base_files
+		empty_directory("app/javascript/src/#{name}/components")
+		empty_directory("app/javascript/src/#{name}/components/#{name}")
+		create_file "app/javascript/src/#{name}/components/#{name}/#{name}.js",
+"import React from 'react';
+import './#{name}.scss';
+
+const #{name} = () => (
+    <div className='#{name}'>
+      <h1>#{name} component!</h1>
+          <p>find me in app/javascript/src/#{name}/components/#{name}/#{name}.js</p>
+    </div>
+)
+
+		export default #{name};"
+		create_file "app/javascript/src/#{name}/components/#{name}/#{name}.scss",
+".#{name} {
+
+}"
+	end
+
+	def create_container_base_files
+		empty_directory("app/javascript/src/#{name}/containers")
+		empty_directory("app/javascript/src/#{name}/containers/#{name}")
+		create_file "app/javascript/src/#{name}/containers/#{name}/#{name}.js",
+"import * as actions from './actions';
+import * as constants from './constants';
+import #{name}Reducer from './#{name}Reducer';
+
+export default { actions, constants, #{name}Reducer };"
+		create_file "app/javascript/src/#{name}/containers/#{name}/actions.js",
+"// import {} from './constants';
+//import * as t from './actionTypes';
+
+//export const someAction = (text) => ({
+//	type: t.SOME_ACTION,
+//	payload: { text }
+//});"
+		create_file "app/javascript/src/#{name}/containers/#{name}/actionTypes.js",
+"//export const SOME_ACTION = '#{name}/SOME_ACTION';"
+
+		create_file "app/javascript/src/#{name}/containers/#{name}/constants.js",
+"// export const SOME_CONST = 'SOME_CONST';"
+
+		create_file "app/javascript/src/#{name}/containers/#{name}/#{name}Reducer.js",
+"const #{name}Reducer = (state = {}, action) => {
+switch (action.type) {
+  default:
+    return state;
+}
+};
+
+export default #{name}Reducer;"
+	end
+
+	def create_pack
+		create_file "app/javascript/packs/#{name}.jsx",
+"// add <%= javascript_pack_tag '#{name}' %> and <%= stylesheet_pack_tag '#{name}' %> to the html.erb file you would like your React App to be rendered.
+
+import React from 'react'
+import { render } from 'react-dom'
+import { Provider } from 'react-redux'
+import { createStore, combineReducers, applyMiddleware } from 'redux'
+
+//this allows you to use the redux devtool in chrome
+import { devToolsEnhancer } from 'redux-devtools-extension'
+
+import { BrowserRouter as Router, Route, Link } from 'react-router-dom'
+
+import #{name} from '../src/#{name}/components/#{name}/#{name}.js'
+
+import rootReducer from '../src/#{name}/reducer'
+
+//this is for devToolsEnhancer otherwise would be 'let store = createStore(rootReducer)'
+let store = createStore(rootReducer, /* preloadedState, */ devToolsEnhancer(
+// Specify name here, actionsBlacklist, actionsCreators and other options if needed
+));
+console.log(store.getState())
+
+// Note that subscribe() returns a function for unregistering the listener
+let unsubscribe = store.subscribe(() =>
+console.log(store.getState())
+)
+
+// Stop listening to state updates
+unsubscribe()
+
+document.addEventListener('DOMContentLoaded', () => {
+render(
+  <Provider store={store}>
+    <Router>
+      <div>
+        <Route path=\"/\" component={#{name}} />
+      </div>
+    </Router>
+  </Provider>,
+  document.body.appendChild(document.createElement('div')),
+)
+})"
+	end
+
+	def insert_into_manifest
+	  inject_into_file "public/packs/manifest.json", "	\"#{name}.js\" : \"http://0.0.0.0:8080/packs/#{name}.js\",\n", :after => "{\n"
+
+	  inject_into_file "public/packs/manifest.json",  "  \"#{name}.css\" : \"http://0.0.0.0:8080/packs/#{name}.css\",\n", :after =>  "\"#{name}.js\" : \"http://0.0.0.0:8080/packs/#{name}.js\",\n"
+	end
+
+end

data/lib/generators/redux_rails/install_generator.rb

@@ -15,7 +15,7 @@ module ReduxRails
 		def create_reducer_base_file
 			create_file "app/javascript/src/#{name}/reducer.js",
 "import { combineReducers } from 'redux'
-import #{name}Reducer from './containers/#{name}/#{name}.js'
+import #{name}Reducer from './containers/#{name}/#{name}Reducer.js'
 
 const rootReducer = combineReducers({
   #{name}Reducer
@@ -51,10 +51,10 @@ const #{name} = () => (
 			create_file "app/javascript/src/#{name}/containers/#{name}/#{name}.js",
 "import * as actions from './actions';
 import * as constants from './constants';
-import #{name}Reducer from './reducer';
+import #{name}Reducer from './#{name}Reducer';
 
 export default { actions, constants, #{name}Reducer };"
-			create_file "app/javascript/src/#{name}/containers/#{name}/action.js",
+			create_file "app/javascript/src/#{name}/containers/#{name}/actions.js",
 "// import {} from './constants';
 //import * as t from './actionTypes';
 
@@ -130,5 +130,6 @@ document.addEventListener('DOMContentLoaded', () => {
 
 		  inject_into_file "public/packs/manifest.json",  "  \"#{name}.css\" : \"http://0.0.0.0:8080/packs/#{name}.css\",\n", :after =>  "\"#{name}.js\" : \"http://0.0.0.0:8080/packs/#{name}.js\",\n"
 		end
+		
 	end
 end

data/lib/redux_rails/version.rb

@@ -1,3 +1,3 @@
 module ReduxRails
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/redux_rails.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Luke Popwell"]
   spec.email         = ["lukepopwell@mac.com"]
   spec.summary       = %q{Setup React and Redux for Rails 5.1}
-  spec.description   = %q{Complete setup for React and Redux into Rails 5.1 pipeline or later. Includes initial install generator, component and container generator. Full description of install located at https://github.com/Luke-Popwell/redux_rails }
+  spec.description   = %q{Complete setup for React and Redux into Rails 5.1 pipeline or later. Includes initial install generator, component and container generator. Full description of install located at "https://github.com/Luke-Popwell/redux_rails" }
   spec.homepage      = "https://github.com/Luke-Popwell/redux_rails"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redux_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Luke Popwell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-07-16 00:00:00.000000000 Z
+date: 2017-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,7 @@ dependencies:
         version: '3.0'
 description: 'Complete setup for React and Redux into Rails 5.1 pipeline or later.
   Includes initial install generator, component and container generator. Full description
-  of install located at https://github.com/Luke-Popwell/redux_rails '
+  of install located at "https://github.com/Luke-Popwell/redux_rails" '
 email:
 - lukepopwell@mac.com
 executables: []
@@ -71,6 +71,7 @@ files:
 - bin/setup
 - lib/generators/component/component_generator.rb
 - lib/generators/container/container_generator.rb
+- lib/generators/pack/pack_generator.rb
 - lib/generators/redux_rails/install_generator.rb
 - lib/redux_rails.rb
 - lib/redux_rails/version.rb