redux_rails 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0458dcd23ed778b5909241bbc905235c77016732'
-  data.tar.gz: 56dd6816d30383dc66564fdc15eafc238740e943
+  metadata.gz: 9b1046f9e1b856388203708b660b93fce9800c0f
+  data.tar.gz: 8c7835e72c424dbee6bbb7ea06cf1849d7b3bb1a
 SHA512:
-  metadata.gz: 9447cf2697c8019fc1fdd5997548a6b2fb5fbdf67477e5807c155f96647f01ef1c87befaa42e7014c4aab52c04f0da8ea3574ce3b54f0f7bfcdb7f11e68a23f8
-  data.tar.gz: 1aafd80b82473c258bfbdbd8469bc2fb0e0a212bd743375ae454eda11b7a9c0c05c293fab6720706797aac6638aca837da2e6b46887598cf5eae47294c4248ea
+  metadata.gz: d455c23cf3e2b0ee4ae93adc30f737779d27ac0c652eef3b4ecf1f3b4e900b34691973c47800adadc12060b5fbd76e404a97416d2bbb7e636985679ef83b7f70
+  data.tar.gz: 62cea610996c0c79e71d11395b6467ffb4ce43f1d72d00088329b3531faa4aa3815d9fb683ea719a92c9b4df242159e96d8c4cbaa0b3f882ecc6f07c09ffadba

data/README.md

@@ -1,14 +1,38 @@
-# ReduxRails
-
-## Highlights
+# ReduxRails [![Gem Version](https://badge.fury.io/rb/redux_rails.svg)](https://badge.fury.io/rb/redux_rails)
+Easily setup React and Redux in Rails -v 5.1. Create re-usable project files and folders for use throughout your project or outside of the current one. Start from scratch or add to an existing project. Redux is setup during the install generator, but not required and still functions correctly. With easy component and container generators you can add to any project and use on any other projects with or without Rails.
+## Table of contents
+- <a href="#reduxrails-">ReduxRails</a>
+- <a href="#highlights">Highlights</a>
+- <a href="#install-generator">Install Generator</a>
+    - <a href="#created-foldersfile">Created folders/files</a>
+    - <a href="#component-folder">Component folder</a>
+    - <a href="#container-folder">Container folder</a>
+- <a href="#pack-generator">Pack Generator</a>
+    - <a href="#created-foldersfile-1">Created folders/files</a>
+    - <a href="#component-folder-1">Component folder</a>
+    - <a href="#container-folder-1">Container folder</a>
+- <a href="#component-generator">Component Generator</a>
+    - <a href="#created-folderfiles">Created folder/files</a>
+- <a href="#container-generator">Container Generator</a>
+    - <a href="#created-folderfiles-1">Created folder/files</a>
+- <a href="#installation">Installation</a>
+- <a href="#usage">Usage</a>
+    - <a href="#install-generator-1">Install Generator</a>
+    - <a href="#pack-generator-1">Pack Generator</a>
+    - <a href="#component-generator-1">Component Generator</a>
+    - <a href="#container-generator-1">Container Generator</a>
+- <a href="#development">Development</a>
+- <a href="#license">License</a>
+### Highlights
 - 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.
+- creates a pack tag for `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.
+- pack generator creates a new React app you can use anywhere in your project. It includes everything from the `redux_rails:install` command without re-installing the javascript dependencies.
 - 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`
+###### <a href="#reduxrails-">Back to top</a>
+### Install Generator
+- Installs the following dependencies `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,17 +54,37 @@
 * app/javascript/src/#{your_app_name}/containers/app/actionTypes.js,
 * app/javascript/src/#{your_app_name}/containers/app/constants.js,
 * app/javascript/src/#{your_app_name}/containers/app/appReducer.js
+###### <a href="#reduxrails-">Back to top</a>
+### Pack Generator
+- 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
+#### Created folders/files
+* app/javascript/src/#{your_app_name},
+* app/javascript/src/#{your_app_name}/reducer.js, `for your combineReducer`
 
-### Pack generator
-#### Runs the Install generator without re-installing the javascript dependencies again
+###### Component folder
+* app/javascript/src/#{your_app_name}/components,
+* app/javascript/src/#{your_app_name}/components/app,
+* app/javascript/src/#{your_app_name}/components/app/app.js,
+* app/javascript/src/#{your_app_name}/components/app/app.scss
 
-### Component generator
+###### Container folder
+* app/javascript/src/#{your_app_name}/containers,
+* app/javascript/src/#{your_app_name}/containers/app,
+* app/javascript/src/#{your_app_name}/containers/app/app.js,
+* app/javascript/src/#{your_app_name}/containers/app/action.js,
+* app/javascript/src/#{your_app_name}/containers/app/actionTypes.js,
+* app/javascript/src/#{your_app_name}/containers/app/constants.js,
+* app/javascript/src/#{your_app_name}/containers/app/appReducer.js
+###### <a href="#reduxrails-">Back to top</a>
+### Component Generator
 #### Created folder/files
 * app/javascript/src/#{your_app_name}/components/app/#{your_component_name},
 * app/javascript/src/#{your_app_name}/components/app/#{your_component_name}/#{your_component_name}.js,
 * app/javascript/src/#{your_app_name}/components/app/#{your_component_name}/#{your_component_name}.scss
-
-### Container generator
+###### <a href="#reduxrails-">Back to top</a>
+### Container Generator
 #### Created folder/files
 * app/javascript/src/#{your_app_name}/containers/#{your_container_name},
 * app/javascript/src/#{your_app_name}/containers/#{your_container_name}/#{your_container_name}.js,
@@ -49,7 +93,7 @@
 * app/javascript/src/#{your_app_name}/containers/#{your_container_name}/constants.js,
 * app/javascript/src/#{your_app_name}/containers/#{your_container_name}/#{your_container_name}Reducer.js
 - each generated container reducer will be imported into #{your_app_name} root reducer at app/javascript/src/#{your_app_name}/reducer.js and included in the combineReducer
-
+###### <a href="#reduxrails-">Back to top</a>
 ## Installation
 
 Create a new Rails project with webpack option
@@ -63,7 +107,7 @@ Then navigate into your new project:
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'redux_rails'
+gem 'redux_rails', '~> 0.1.4'
 ```
 
 And then execute:
@@ -80,7 +124,7 @@ To allow javascript_pack_tag to load assets from webpack-dev-server navigate to
 config.x.webpacker[:dev_server_host] = "http://127.0.0.1:8080"
 ```
 
-To create the packs/manifest.json run:
+To create the `packs/manifest.json` run:
 
     $ bin/webpack-dev-server --host 127.0.0.1
 
@@ -109,11 +153,11 @@ At this point, Rails has created a javascript friendly app for you. To render th
 ```
 Hello React!
 ```
-
+###### <a href="#reduxrails-">Back to top</a>
 ## Usage
 
 ### Install generator
-###### *only run this once! If you wish to create additional pack files run `rails generate redux_rails:pack #{pack_name}`*
+###### *only run this once! If you wish to create additional pack files run `rails generate 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'*
 
@@ -141,7 +185,7 @@ 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:
+Once the Install Generator is finished:
 1. add the following pack_tags to the file you want the react component to be rendered in
 ```
 <%= javascript_pack_tag '#{your_app_name}' %>
@@ -150,8 +194,9 @@ Once the install generator is finished:
 2. Restart your servers or open two new ones with the commands above and navigate to the page in your browser and you should see:
 ```
 #{your_app_name} component!
-find me in find me in app/javascript/src/#{your_app_name}/components/#{your_app_name}#{your_app_name}.js
+find me in find me in app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.js
 ```
+###### <a href="#reduxrails-">Back to top</a>
 ### 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'*
@@ -178,10 +223,21 @@ This will generate a new React app inside of the `app/javascript/src` folder. In
 - `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`
 
-
+Once the Pack Generator is finished:
+1. add the following pack_tags to the file you want the react component to be rendered in
+```
+<%= javascript_pack_tag '#{your_app_name}' %>
+<%= stylesheet_pack_tag '#{your_app_name}' %>
+```
+2. Restart your servers or open two new ones with the commands above and navigate to the page in your browser and you should see:
+```
+#{your_app_name} component!
+find me in find me in app/javascript/src/#{your_app_name}/components/#{your_app_name}/#{your_app_name}.js
+```
+###### <a href="#reduxrails-">Back to top</a>
 ### Component generator
 The Component generator takes two arguments (the new Component name and the desired install location)
-###### *if you leave #{your_app_name} or #{your_component_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}
@@ -190,10 +246,10 @@ This will generate a new folder inside of your components folder with the follow
 - `app/javascript/src/#{your_app_name}/components/#{your_component_name}`
 - `app/javascript/src/#{your_app_name}/components/#{your_component_name}/#{your_component_name}.js`
 - `app/javascript/src/#{your_app_name}/components/#{your_component_name}/#{your_component_name}.scss`
-
+###### <a href="#reduxrails-">Back to top</a>
 ### Container generator
 The Container generator takes two arguments (the new Container name and the desired install location)
-###### *if you leave #{your_app_name} or #{your_container_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}
@@ -205,15 +261,13 @@ This will generate a new folder inside of your containers folder with the follow
 - `app/javascript/src/#{your_app_name}/containers/#{your_container_name}/actionTypes.js`
 - `app/javascript/src/#{your_app_name}/containers/#{your_container_name}/constants.js`
 - `app/javascript/src/#{your_app_name}/containers/#{your_container_name}/#{your_container_name}Reducer.js`
-
-
-
+###### <a href="#reduxrails-">Back to top</a>
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
+###### <a href="#reduxrails-">Back to top</a>
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/Luke-Popwell/redux_rails.
@@ -221,3 +275,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Luke-P
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+###### <a href="#reduxrails-">Back to top</a>

data/lib/generators/container/container_generator.rb

@@ -11,10 +11,10 @@ class ContainerGenerator < Rails::Generators::NamedBase
 		create_file "app/javascript/src/#{install_folder_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/#{install_folder_name}/containers/#{name}/action.js",
+    create_file "app/javascript/src/#{install_folder_name}/containers/#{name}/actions.js",
 "// import {} from './constants';
 //import * as t from './actionTypes';
 
@@ -39,7 +39,7 @@ export default #{name}Reducer;"
 	end
 
   def add_namedReducer_to_reducer
-    inject_into_file "app/javascript/src/#{install_folder_name}/reducer.js", "import #{name}Reducer from './containers/#{name}/#{name}.js'\n", :after => "import { combineReducers } from 'redux'\n"
+    inject_into_file "app/javascript/src/#{install_folder_name}/reducer.js", "import #{name}Reducer from './containers/#{name}/#{name}Reducer.js'\n", :after => "import { combineReducers } from 'redux'\n"
 
     inject_into_file "app/javascript/src/#{install_folder_name}/reducer.js", "  #{name}Reducer,\n", :after => "const rootReducer = combineReducers({\n"
   end

data/lib/redux_rails/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redux_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Luke Popwell