plug 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abca8d64bea6f07000560960f761ef8cf9685ab1
-  data.tar.gz: 0f607e0b63a90f7abdba554aac17c97cd240d5e9
+  metadata.gz: 19246ab9387032253ed9b13aac4fb10bd03cbf41
+  data.tar.gz: b63f935e9e157e70d1b98d9583c0d478ed541ce4
 SHA512:
-  metadata.gz: e7731f594219d50f5134b6a00a668b41af41b2bb80a8b7a5a51cbbf56ae5ccf743eafb8658ebb46cd9cf7350eb7b949ab1833ae7dbbbdfb9fc5209a0103fe19f
-  data.tar.gz: 7ffd23598f9f7f70727d344a1693d95632e4a7cd948235046cfdc1c87c23a43f504b86dd93a56334ecd85211fe1c60502911f5d5a2c5f6ffe5a987116333f7e6
+  metadata.gz: a48e1d5fbe882b65012799c3a18445c54fb8097bb61c7fd4ddc93b79798e0589228ffb099a224c7668e9c4490eaa7acb1eb69cd492121162dad48a602d9cb011
+  data.tar.gz: 50323022408bd5474cabbe4d3a18e154021a2a2a843841a6c848fb9b9559af1454d3d4438b93ffc6993777b58d7ae9f2d0cd7b1eae87152845bfba5c2a2e4308

data/README.md

@@ -1,28 +1,68 @@
-# Plug
-Short description and motivation.
+# 🔌 Plug
 
-## Usage
-How to use my plugin.
+A Rails engine to turn on/off features (Feature flipper).
+
+### Features
+
+- Supports Rails 3 and above
+- MySQL
+- Set notices (WIP)
+
+### Prerequisites
+
+- Rails version 3 and above
+- MySQL
+
+### Getting Started
 
-## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
 gem 'plug'
 ```
 
-And then execute:
+Execute:
+
 ```bash
-$ bundle
+→ bundle
 ```
 
-Or install it yourself as:
+And run the install generator:
+
 ```bash
-$ gem install plug
+→ rails g plug:install
+→ rails g plug:install:migrations
+→ rails db:migrate # Newer version of Rails
+→ rake db:migrate # Older version of Rails
+→ rails s
 ```
 
-## Contributing
-Contribution directions go here.
+### Usage
+
+Go to `localhost:3000/plug` and start creating features.
+
+Use the provided method to check if the feature is enabled.
+
+```ruby
+Plug.enabled?('my-awesome-feature-slug')
+```
+
+If you wanted to restrict routes, you can use `Plug::Constraint` class
+
+```ruby
+Rails.application.routes.draw do
+  resources :blog, constraint: Plug::Constraint.new('my-awesome-feature-slug')
+end
+```
+
+### Questions/Issues?
+
+File a new [issue](https://github.com/boost/plug/issues/new) if you have questions or issues.
+
+### Contributing
 
-## License
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+1. Fork it ( https://github.com/boost/plug/fork )
+2. Create your feature branch (`git checkout -b my-awesome-feature`)
+3. Commit your changes (`git commit -am 'Add my awesome feature!'`)
+4. Push to the branch (`git push origin my-awesome-feature`)
+5. Create a new Pull Request

data/lib/generators/plug/install_generator.rb

@@ -0,0 +1,13 @@
+module Plug
+  class InstallGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+
+    def copy_initializer_file
+      copy_file 'plug.rb', 'config/initializers/plug.rb'
+    end
+
+    def mount_engine
+      inject_into_file('config/routes.rb', "\n  mount Plug::Engine => '/plug', as: 'plug'\n\n", :before => /^end/)
+    end
+  end
+end

data/lib/generators/plug/templates/plug.rb

@@ -0,0 +1,6 @@
+# /config/initializers/plug.rb
+ 
+Plug.configure do |config|
+  config.auth_user = 'admin'
+  config.auth_password = 'password'
+end

data/lib/plug/version.rb

@@ -1,3 +1,3 @@
 module Plug
-  VERSION = '0.1.7'
+  VERSION = '0.1.8'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plug
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Ben
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-18 00:00:00.000000000 Z
+date: 2017-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -222,6 +222,8 @@ files:
 - app/views/plug/shared/_nav.html.haml
 - config/routes.rb
 - db/migrate/20171207020316_create_plug_features.rb
+- lib/generators/plug/install_generator.rb
+- lib/generators/plug/templates/plug.rb
 - lib/plug.rb
 - lib/plug/configuration.rb
 - lib/plug/constraint.rb