acts_as_shellscript_executable 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 722aca7c7a8f0e82959146778aca5747f639e3f5
-  data.tar.gz: 7d7676df80465c0edb8f14a4c09a301612aebafb
+  metadata.gz: 190be56029b641566b7aad1e32156a01f482df48
+  data.tar.gz: a81c819d7d98661b72fde5ba7b39963506eabd5d
 SHA512:
-  metadata.gz: 4d809017d6ff92571c6541f34124520e43013586f31ccfbb30b5fbe33e1486a1860fc054f6f7410dfe548637436da1e44dd7384e4d3e4a5ec63ba7a329649a8c
-  data.tar.gz: bd773b89ce5a3dd93e347d089f83a80c00b4b51d5e28b70f9a01b59bb88413263923840f4770f8bd1676180f7bc1e18b308710631e9c3d25fcae0749ba4b9360
+  metadata.gz: 8acbe54b17e19cabb50f8aacac224bbc66cc69e70b428d090f8db334bcc3a7a8a154180a6bf480b30ee4174f557ee96ecc22891e44d14bb2cf603ced3373bd45
+  data.tar.gz: 5b0554b894a5467f6a9a3c038b61e9c7dc4a07395d61c538a097786c0486a733b7ff4405c83899990c32a854e7f9c39ddbdd3c357f847e0e87d15d5afe0fd2ef

data/.rspec

@@ -1,2 +1,3 @@
 --color
 --format documentation
+--order rand

data/.rubocop.yml

@@ -0,0 +1,5 @@
+Documentation:
+  Enabled: false
+AllCops:
+  Exclude:
+    - acts_as_shellscript_executable.gemspec

data/.travis.yml

@@ -1,7 +1,11 @@
 language: ruby
 rvm:
+  - 2.1.3
   - 2.1.2
   - 2.1.0
   - 2.0.0
   - 1.9.3
   - 'ruby-head'
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'coveralls', require: false
+gem 'rubocop', require: false

data/README.md

@@ -1,31 +1,55 @@
 # ActsAsShellscriptExecutable
 
-[![travis-batch](https://travis-ci.org/hoshinotsuyoshi/acts_as_shellscript_executable.svg)](https://travis-ci.org/hoshinotsuyoshi/acts_as_shellscript_executable)
+[![travis-batch](https://travis-ci.org/hoshinotsuyoshi/acts_as_shellscript_executable.svg?branch=master)](https://travis-ci.org/hoshinotsuyoshi/acts_as_shellscript_executable)
 [![Coverage Status](https://coveralls.io/repos/hoshinotsuyoshi/acts_as_shellscript_executable/badge.png)](https://coveralls.io/r/hoshinotsuyoshi/acts_as_shellscript_executable)
 [![Code Climate](https://codeclimate.com/github/hoshinotsuyoshi/acts_as_shellscript_executable/badges/gpa.svg)](https://codeclimate.com/github/hoshinotsuyoshi/acts_as_shellscript_executable)
 
 
-    class Script < ActiveRecord::Base
-      acts_as_shellscript_executable script: :script, stdout: :result
-    end
-
 ### before:
 
-| id  | name  | script | result |
-| :------|:------ |:---------------|:-----|
-| 1  | foo   | echo 'lalala' |  |
-
+| id  | name  | script        | result |
+| :---|:----- |:--------------|:-------|
+| 1   | foo   | echo 'lalala' |        |
 
 ### execute:
 
-    script = Script.find(1)
-    script.execute!
+```ruby
+class Script < ActiveRecord::Base
+  acts_as_shellscript_executable script: :script
+end
+```
+
+```ruby
+script = Script.find(1)
+script.result = script.execute!
+script.save!
+```
 
 ### after:
-    
-| id  | name  | script | result |
-| :------|:------ |:---------------|:-----|
-| 1  | foo   | echo 'lalala' | lalala |
+
+| id  | name  | script        | result |
+| :---|:----- |:--------------|:-------|
+| 1   | foo   | echo 'lalala' | lalala |
+
+## #execute!
+
+* `#execute!(nil)`
+    * returns scripts stdout of whole of the shellscript
+
+* `#execute!(block)`
+    * returns `nil`, yields the shellscript's stdout st each line(splited by `\n`)
+
+## Options of `.acts_as_shellscript_executable`
+
+* `script:` (default: `:script`)
+    * if `Symbol`, the same name column's value will be evaluated as shellscript
+    * if `String`, the string will be evaluated as shellscript
+
+* `parallel:` (default: `false`)
+    * if true, the script will run in parallel by using `thread`
+
+* `method:` (default: `execute!`)
+    * the execute method's name
 
 ## Installation
 
@@ -43,7 +67,7 @@ Or install it yourself as:
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/acts_as_shellscript_executable/fork )
+1. Fork it ( http://github.com/hoshinotsuyoshi/acts_as_shellscript_executable/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/Rakefile

@@ -1,6 +1,6 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/acts_as_shellscript_executable.rb

@@ -1,5 +1,6 @@
 require 'acts_as_shellscript_executable/version'
-require 'acts_as_shellscript_executable/active_record/acts/shellscript_executable'
+require 'acts_as_shellscript_executable/active_record/' \
+          'acts/shellscript_executable'
 
 module ActsAsShellscriptExecutable
   if defined? Rails::Railtie
@@ -17,7 +18,8 @@ module ActsAsShellscriptExecutable
     def self.insert
       if defined?(ActiveRecord)
         require 'active_record'
-        ActiveRecord::Base.send(:include, ActiveRecord::Acts::ShellscriptExecutable)
+        ActiveRecord::Base.send \
+          :include, ActiveRecord::Acts::ShellscriptExecutable
       end
     end
   end

data/lib/acts_as_shellscript_executable/active_record/acts/shellscript_executable.rb

@@ -1,3 +1,5 @@
+require 'thread'
+
 module ActiveRecord
   module Acts
     module ShellscriptExecutable
@@ -7,44 +9,44 @@ module ActiveRecord
 
       module ClassMethods
         def acts_as_shellscript_executable(options = {})
-          @@configuration = { script: :script, stdout: nil }
-          @@configuration.update(options) if options.is_a?(Hash)
+          configuration = { method: :execute!, script: :script }
+          configuration.update(options) if options.is_a?(Hash)
 
           class_eval <<-EOV
-            include ::ActiveRecord::Acts::ShellscriptExecutable::InstanceMethods
-
+            def #{configuration[:method]}(&block)
+              script = @@__configuration__[:script]
+              answer = ''
+              if @@__configuration__[:parallel]
+                Thread.new do
+                  __execute__(script, answer, block)
+                end
+                block_given? ? nil : answer
+              else
+                __execute__(script, answer, block)
+                block_given? ? nil : answer
+              end
+            end
           EOV
-        end
 
-        def configuration
-          @@configuration
+          class_variable_set(:@@__configuration__, configuration)
+          include ::ActiveRecord::Acts::ShellscriptExecutable::InstanceMethods
         end
       end
 
       module InstanceMethods
-        def execute!
-          script = configuration[:script]
-          stdout = configuration[:stdout]
-          if configuration[:fork]
-            fork { execute(script, stdout) }
-            # for test
-            Process.wait if ENV['test']
-          else
-            execute(script, stdout)
-          end
-        end
-
         private
-        def configuration
-          self.class.configuration
-        end
 
-        def execute(script, stdout)
-          retval = %x(#{send script})
-          if stdout && respond_to?("#{stdout}=".to_sym)
-            send("#{stdout}=".to_sym, retval)
+        def __execute__(script, answer, block = nil)
+          script = send script if script.is_a? Symbol
+          retval = []
+          script.split("\n").each do |line|
+            if block
+              block.call `#{line}`
+            else
+              retval << `#{line}`
+            end
           end
-          save!
+          answer.replace retval.join
         end
       end
     end

data/lib/acts_as_shellscript_executable/version.rb

@@ -1,7 +1,7 @@
 module ActiveRecord
   module Acts
     module ShellscriptExecutable
-      VERSION = '0.0.0'
+      VERSION = '0.0.1'
     end
   end
 end

data/spec/features/acts_as_shellscript_executable_spec.rb

@@ -1,14 +1,16 @@
 require 'spec_helper'
-require 'tmpdir'
 
 describe ActiveRecord::Base do
   describe '.acts_as_shellscript_executable' do
     def db_setup!
-      # use not-in-memory-sqlite-db. because of fork
-      db_dir = Dir.mktmpdir('db')
-      ActiveRecord::Base.establish_connection(adapter: "sqlite3", database: "#{db_dir}/db.sqlite3")
+      ActiveRecord::Base.establish_connection \
+        adapter: 'sqlite3', database: ':memory:'
       ActiveRecord::Schema.verbose = false
       ActiveRecord::Base.connection.schema_cache.clear!
+      db_schema_define!
+    end
+
+    def db_schema_define!
       ActiveRecord::Schema.define(version: 1) do
         create_table :scripts do |t|
           t.column :script,  :string
@@ -32,67 +34,48 @@ describe ActiveRecord::Base do
       it do
         script = Script.create
         script.script = 'echo "lalala"'
-        expect{script.execute!}.to_not \
-          change{script.result}
+        expect(script.execute!).to eq "lalala\n"
       end
     end
 
-    context 'given option {script: :script, stdout: :result}' do
-      before do
-        class Script < ActiveRecord::Base
-          acts_as_shellscript_executable script: :script, stdout: :result
-        end
-      end
-
-      it do
-        script = Script.create
-        script.script = 'echo "lalala"'
-        expect{script.execute!}.to \
-          change{script.result}.from(nil).to("lalala\n")
-      end
-    end
-
-    describe 'given option fork' do
-      context 'given option {script: :script, stdout: :result, fork: false}' do
+    describe 'given option parallel' do
+      context 'given option {script: :script, parallel: false}' do
         before do
           class Script < ActiveRecord::Base
-            acts_as_shellscript_executable script: :script, stdout: :result, fork: false
+            acts_as_shellscript_executable script: :script, parallel: false
           end
         end
 
         it do
           script = Script.create
-          pid = Process.pid
-          script.script = 'echo $PPID' # this $PPID is equal to $$
-          expect{script.execute!}.to \
-            change{script.result}.from(nil).to("#{Process.pid}\n")
+          script.script = 'echo $PPID'
+          expect(script.execute!).to eq "#{Process.pid}\n"
         end
       end
 
-      context '[forking] given option {script: :script, stdout: :result, fork: true}' do
+      context 'given option {script: :script, parallel: true}' do
         before do
           class Script < ActiveRecord::Base
-            acts_as_shellscript_executable script: :script, stdout: :result, fork: true
+            acts_as_shellscript_executable script: :script, parallel: true
           end
-
-          @script = Script.create
-          @script.script = 'echo $PPID' # when fork, this $PPID is not equal to $$
-          @script.execute!
         end
 
         it do
-          # reset object because of fork
-          @script = Script.find @script.id
-          expect(@script.result).not_to equal nil
-          expect(@script.result).not_to eq("#{Process.pid}\n")
+          script = Script.create
+          script.script = "sleep 1\necho $PPID"
+          result = script.execute!
+
+          expect(result).to eq('')
+          sleep 1.5
+          expect(result).to eq("#{Process.pid}\n")
         end
       end
     end
 
-    context 'given option {script: :script2, stdout: :result}' do
+    context 'given option { script: :script2 }' do
       before do
         class Script < ActiveRecord::Base
-          acts_as_shellscript_executable script: :script2, stdout: :result
+          acts_as_shellscript_executable script: :script2
         end
       end
 
@@ -100,8 +83,109 @@ describe ActiveRecord::Base do
         script = Script.create
         script.script  = 'echo "hehehe"'
         script.script2 = 'echo "lalala"'
-        expect{script.execute!}.to \
-          change{script.result}.from(nil).to("lalala\n")
+        expect(script.execute!).to eq "lalala\n"
+      end
+    end
+
+    context 'given option { script: "echo 1;" }' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable script: 'echo 1;'
+        end
+      end
+
+      it do
+        script = Script.create
+        script.script  = 'echo "hehehe"'
+        expect(script.execute!).to eq "1\n"
+      end
+    end
+
+    context 'given option {script: "echo 1\necho 2"}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable script: "echo 1\necho 2"
+        end
+      end
+
+      it do
+        script = Script.create
+        script.script  = 'echo "hehehe"'
+        result = script.execute!
+        expect(result).to eq "1\n2\n"
+      end
+    end
+
+    context 'given option {script: "echo 1\nsleep 1\necho 2" parallel: true}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable \
+            script: "echo 1\nsleep 1\necho 2", parallel: true
+        end
+      end
+
+      describe 'block given' do
+        it do
+          script = Script.create
+          watcher = []
+
+          retval = script.execute! do |each_line_result|
+            watcher << each_line_result
+          end
+
+          sleep 2
+
+          expect(retval).to be_nil
+          expect(watcher).to eq ["1\n", '', "2\n"]
+        end
+      end
+    end
+
+    context 'given option {script: "echo 1\necho 2"}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable \
+            script: "echo 1\necho 2"
+        end
+      end
+
+      describe 'block given' do
+        it do
+          script = Script.create
+          watcher = []
+
+          retval = script.execute! do |each_line_result|
+            watcher << each_line_result
+          end
+
+          expect(retval).to be_nil
+          expect(watcher).to eq ["1\n", "2\n"]
+        end
+      end
+    end
+
+    context 'given option {method: :awesome!}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable \
+            method: :awesome!, script: "echo 1\nsleep 1\necho 2", parallel: true
+        end
+      end
+
+      describe 'block given' do
+        it do
+          script = Script.create
+          watcher = []
+
+          retval = script.awesome! do |each_line_result|
+            watcher << each_line_result
+          end
+
+          sleep 2
+
+          expect(retval).to be_nil
+          expect(watcher).to eq ["1\n", '', "2\n"]
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_shellscript_executable
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - hoshinotsuyoshi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-21 00:00:00.000000000 Z
+date: 2014-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -103,6 +103,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile