acts_as_shellscript_executable 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 722aca7c7a8f0e82959146778aca5747f639e3f5
+  data.tar.gz: 7d7676df80465c0edb8f14a4c09a301612aebafb
+SHA512:
+  metadata.gz: 4d809017d6ff92571c6541f34124520e43013586f31ccfbb30b5fbe33e1486a1860fc054f6f7410dfe548637436da1e44dd7384e4d3e4a5ec63ba7a329649a8c
+  data.tar.gz: bd773b89ce5a3dd93e347d089f83a80c00b4b51d5e28b70f9a01b59bb88413263923840f4770f8bd1676180f7bc1e18b308710631e9c3d25fcae0749ba4b9360

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.ruby-version

@@ -0,0 +1 @@
+2.1

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - 'ruby-head'

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_shellscript_executable.gemspec
+gemspec
+
+gem 'coveralls', require: false

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 hoshinotsuyoshi
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# ActsAsShellscriptExecutable
+
+[![travis-batch](https://travis-ci.org/hoshinotsuyoshi/acts_as_shellscript_executable.svg)](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' |  |
+
+
+### execute:
+
+    script = Script.find(1)
+    script.execute!
+
+### after:
+    
+| id  | name  | script | result |
+| :------|:------ |:---------------|:-----|
+| 1  | foo   | echo 'lalala' | lalala |
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_shellscript_executable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_shellscript_executable
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/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`)
+5. Create new Pull Request

data/Rakefile

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

data/acts_as_shellscript_executable.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_shellscript_executable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "acts_as_shellscript_executable"
+  spec.version       = ActiveRecord::Acts::ShellscriptExecutable::VERSION
+  spec.authors       = ["hoshinotsuyoshi"]
+  spec.email         = ["guitarpopnot330@gmail.com"]
+  spec.summary       = %q{#execute! executes column's content as shellscript}
+  spec.description   = %q{}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "sqlite3"
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_dependency("activerecord", [">= 4.1.6"])
+end

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

@@ -0,0 +1,52 @@
+module ActiveRecord
+  module Acts
+    module ShellscriptExecutable
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def acts_as_shellscript_executable(options = {})
+          @@configuration = { script: :script, stdout: nil }
+          @@configuration.update(options) if options.is_a?(Hash)
+
+          class_eval <<-EOV
+            include ::ActiveRecord::Acts::ShellscriptExecutable::InstanceMethods
+
+          EOV
+        end
+
+        def configuration
+          @@configuration
+        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)
+          end
+          save!
+        end
+      end
+    end
+  end
+end

data/lib/acts_as_shellscript_executable/version.rb

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

data/lib/acts_as_shellscript_executable.rb

@@ -0,0 +1,26 @@
+require 'acts_as_shellscript_executable/version'
+require 'acts_as_shellscript_executable/active_record/acts/shellscript_executable'
+
+module ActsAsShellscriptExecutable
+  if defined? Rails::Railtie
+    require 'rails'
+    class Railtie < Rails::Railtie
+      initializer 'acts_as_shellscript_executable.insert_into_active_record' do
+        ActiveSupport.on_load :active_record do
+          ActsAsShellscriptExecutable::Railtie.insert
+        end
+      end
+    end
+  end
+
+  class Railtie
+    def self.insert
+      if defined?(ActiveRecord)
+        require 'active_record'
+        ActiveRecord::Base.send(:include, ActiveRecord::Acts::ShellscriptExecutable)
+      end
+    end
+  end
+end
+
+ActsAsShellscriptExecutable::Railtie.insert

data/spec/features/acts_as_shellscript_executable_spec.rb

@@ -0,0 +1,108 @@
+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::Schema.verbose = false
+      ActiveRecord::Base.connection.schema_cache.clear!
+      ActiveRecord::Schema.define(version: 1) do
+        create_table :scripts do |t|
+          t.column :script,  :string
+          t.column :script2, :string
+          t.column :result,  :string
+        end
+      end
+    end
+
+    before do
+      db_setup!
+    end
+
+    context 'given option {script: :script}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable script: :script
+        end
+      end
+
+      it do
+        script = Script.create
+        script.script = 'echo "lalala"'
+        expect{script.execute!}.to_not \
+          change{script.result}
+      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
+        before do
+          class Script < ActiveRecord::Base
+            acts_as_shellscript_executable script: :script, stdout: :result, fork: 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")
+        end
+      end
+
+      context '[forking] given option {script: :script, stdout: :result, fork: true}' do
+        before do
+          class Script < ActiveRecord::Base
+            acts_as_shellscript_executable script: :script, stdout: :result, fork: 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")
+        end
+      end
+    end
+
+    context 'given option {script: :script2, stdout: :result}' do
+      before do
+        class Script < ActiveRecord::Base
+          acts_as_shellscript_executable script: :script2, stdout: :result
+        end
+      end
+
+      it do
+        script = Script.create
+        script.script  = 'echo "hehehe"'
+        script.script2 = 'echo "lalala"'
+        expect{script.execute!}.to \
+          change{script.result}.from(nil).to("lalala\n")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'coveralls'
+Coveralls.wear!
+ENV['test'] = 'true'
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'acts_as_shellscript_executable'
+require 'rspec'

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_shellscript_executable
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- hoshinotsuyoshi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.6
+description: ''
+email:
+- guitarpopnot330@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_shellscript_executable.gemspec
+- lib/acts_as_shellscript_executable.rb
+- lib/acts_as_shellscript_executable/active_record/acts/shellscript_executable.rb
+- lib/acts_as_shellscript_executable/version.rb
+- spec/features/acts_as_shellscript_executable_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: "#execute! executes column's content as shellscript"
+test_files:
+- spec/features/acts_as_shellscript_executable_spec.rb
+- spec/spec_helper.rb