plur 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba75a18a139f24af74eef957214ee607f774374c
-  data.tar.gz: 339fa96c7be54ad3c396b8426b58c4d939505e0d
+  metadata.gz: f21421aaad32806bb70c97178a8bef8a7583abbf
+  data.tar.gz: 8dc3966101c5b26fc1a22f94a6bdad89bcca45b5
 SHA512:
-  metadata.gz: 9394bff83dbbe6a3661d160984d10dc30a701cb149cfb5b291c0a727a34b5c797e2a985ec742f5d7966c237eab9d341b51e35a69999275fa922069f0dca89627
-  data.tar.gz: cf7525d61eb17a0ccd852e9e9190a5cb68ff3e932182ba1afc938ee89ec0316c1bb24ea6b38b9cf4207d7a12048437b0e85d881b59cc3878b8a0e75941130a65
+  metadata.gz: 9661c9a16374d3416986878d40571fd076507b1356ba59cc7bffb77150d37fcda1c4f98142a60daaaf88720d63f2299eb90380186935c6ac5696f57cdd3d180c
+  data.tar.gz: 5cd184a1a28284a8fd46c16c7d79656664f4dbd7e5e8677b84ade502cd38413385189de0a6277720e18dba18ec60c367edd53df161f73db92bbba960487fed3b

data/README.markdown

@@ -1,24 +1,67 @@
 # Plur
 
-TODO: Write a gem description
+Opinionated development workflow and commonly used tools for Ruby on Rails based development.
+
+![Logo](https://raw.github.com/subosito/plur/master/images/slank-plur.jpg)
 
 ## Installation
 
-Add this line to your application's Gemfile:
+As usual, add the Plur into your Gemfile:
 
     gem 'plur'
 
-And then execute:
+## Usage
 
-    $ bundle
+Currently there are two parts on Plur, deployment and helper:
 
-Or install it yourself as:
+### Deployment
 
-    $ gem install plur
+If you're using [Capistrano](https://github.com/capistrano/capistrano), [Figaro](https://github.com/laserlemon/figaro), [Foreman](https://github.com/ddollar/foreman), and deploy it into Ubuntu box or any OS that use [Upstart](http://upstart.ubuntu.com), then you're on right track :)
 
-## Usage
+    # deploy.rb
+    require 'plur/capistrano'
+
+    #
+    ## Below is the default value, I mean you don't need write these, except you are differ.
+    #
+
+    # foreman
+    set :foreman_format,      "upstart"
+    set :foreman_location,    "/etc/init"
+    set :foreman_procfile,    "Procfile"
+    set :foreman_root,        release_path
+    set :foreman_port,        5000
+    set :foreman_app,         application
+    set :foreman_user,        user
+    set :foreman_log,         'shared_path/log'
+    set :foreman_concurrency, false
+
+    # figaro
+    set :figaro_yaml,     true
+    set :figaro_symlink,  true
+    set :figaro_output,   'shared_path/application.yml'
+    set :figaro_config,   'latest_release/config/application.yml'
 
-TODO: Write usage instructions here
+    # upstart
+    set :service_name, application
+
+If you like to locally precompile assets to reduce load on server, you can add:
+
+    # deploy.rb
+    require 'plur/capistrano/local'
+
+### Helpers
+
+By default Plur will install several helpers, see [view.rb](https://github.com/subosito/plur/blob/master/lib/plur/helpers/view.rb):
+
+    - current_locale
+    - rtl_locales
+    - rtl?
+    - orientation
+    - notifications
+    - namespace_name
+    - body_attributes
+    - build_html
 
 ## Contributing
 
@@ -27,3 +70,4 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+

data/lib/plur/capistrano.rb

@@ -1,4 +1,8 @@
+# recipes
 require "plur/capistrano/foreman"
 require "plur/capistrano/upstart"
 require "plur/capistrano/figaro"
-require "plur/capistrano/local"
+
+Capistrano::Configuration.instance(:must_exist).load do
+  _cset :plur_callback, true
+end

data/lib/plur/capistrano/figaro.rb

@@ -18,11 +18,17 @@ Capistrano::Configuration.instance(:must_exist).load do
       transfer :up, figaro_tmpfile, figaro_output, via: :scp
       run_locally "rm #{figaro_tmpfile}"
     end
+
+    task :config_symlink, roles: :app do
+      run "ln -sf #{figaro_output} #{figaro_config}"
+    end
   end
 
-  after 'deploy:setup', 'figaro:config'
+  after 'deploy:setup' do
+    figaro.config if plur_callback
+  end
 
   after 'deploy:finalize_update' do
-    run "ln -sf #{figaro_output} #{figaro_config}" if figaro_symlink
+    figaro.config_symlink if plur_callback and figaro_symlink
   end
 end

data/lib/plur/capistrano/foreman.rb

@@ -18,7 +18,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     task :export, roles: :app do
       bundle_cmd          = fetch(:bundle_cmd, "bundle")
       foreman_format      = fetch(:foreman_format, "upstart")
-      foreman_location    = fetch(:foreman_location, "/etc/init/app")
+      foreman_location    = fetch(:foreman_location, "/etc/init")
       foreman_procfile    = fetch(:foreman_procfile, "Procfile")
       foreman_port        = fetch(:foreman_port, 5000)
       foreman_root        = fetch(:foreman_root, current_path)
@@ -35,9 +35,11 @@ Capistrano::Configuration.instance(:must_exist).load do
       args << "-u #{foreman_user}"
       args << "-l #{foreman_log}"
       args << "-c #{foreman_concurrency}" if foreman_concurrency
-      run "cd #{release_path} && #{bundle_cmd} exec foreman export #{args.join(' ')}"
+      run "cd #{release_path} && #{sudo} #{bundle_cmd} exec foreman export #{args.join(' ')}"
     end
   end
 
-  after 'deploy:update', 'foreman:export'
+  after 'deploy:update' do
+    foreman.export if plur_callback
+  end
 end

data/lib/plur/capistrano/local.rb

@@ -10,7 +10,6 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
   end
 
-  # TODO: allow to turn it off
   namespace :deploy do
     namespace :assets do
       task :precompile, roles: :web, except: { no_release: true } do

data/lib/plur/capistrano/upstart.rb

@@ -1,6 +1,6 @@
 Capistrano::Configuration.instance(:must_exist).load do
   namespace :upstart do
-    _cset(:service_name) { "app/#{application}" }
+    _cset(:service_name) { application }
 
     desc "Start the application services"
     task :start, roles: :app do
@@ -18,5 +18,7 @@ Capistrano::Configuration.instance(:must_exist).load do
     end
   end
 
-  after 'deploy:restart', 'upstart:restart'
+  after 'deploy:restart' do
+    upstart.restart if plur_callback
+  end
 end

data/lib/plur/version.rb

@@ -1,3 +1,3 @@
 module Plur
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/plur.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |gem|
   gem.version       = Plur::VERSION
   gem.authors       = ["Alif Rachmawadi"]
   gem.email         = ["subosito@gmail.com"]
-  gem.description   = %q{Quite useful things}
+  gem.description   = %q{Opinionated development workflow and commonly used tools for Ruby on Rails based development.}
   gem.summary       = gem.description
   gem.homepage      = "https://github.com/subosito/plur"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plur
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Alif Rachmawadi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-25 00:00:00.000000000 Z
+date: 2013-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mab
@@ -24,7 +24,8 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.0.2
-description: Quite useful things
+description: Opinionated development workflow and commonly used tools for Ruby on
+  Rails based development.
 email:
 - subosito@gmail.com
 executables: []
@@ -36,6 +37,7 @@ files:
 - LICENSE.txt
 - README.markdown
 - Rakefile
+- images/slank-plur.jpg
 - lib/plur.rb
 - lib/plur/capistrano.rb
 - lib/plur/capistrano/figaro.rb
@@ -68,5 +70,6 @@ rubyforge_project:
 rubygems_version: 2.0.0
 signing_key: 
 specification_version: 4
-summary: Quite useful things
+summary: Opinionated development workflow and commonly used tools for Ruby on Rails
+  based development.
 test_files: []