data_maintenance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ba86066fefbd92cab3678775a900988726d7dc7250dbe336e5401731241a3a62
+  data.tar.gz: e8037ec5be6e3433d29ec4ffa96ce1341ae6ad99d76398ad765546006ab21ca1
+SHA512:
+  metadata.gz: a0f6a618b3b38551bf5fc7fe66c02f1f3a3492b8da9ed17700a53d49569883e22daec53657f8fd6e96be46094a922513af80c314646280e2e885120849bb5f95
+  data.tar.gz: 66d93ded353ab298d2a9e897c7445b01faa041dc6b04577b1af747910d85a3e5e3bc6ded9035036a1e644a43c24ac8eb62f9292acde3352039f7238a4f5a7e79

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in data_maintenance.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    data_maintenance (0.1.0)
+      railties (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.0)
+      actionview (= 5.2.0)
+      activesupport (= 5.2.0)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.0)
+      activesupport (= 5.2.0)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    erubi (1.7.1)
+    i18n (1.0.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (0.9.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nokogiri (1.8.4)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.5)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.0)
+      actionpack (= 5.2.0)
+      activesupport (= 5.2.0)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  data_maintenance!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tomohisa KURANARI
+
+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,49 @@
+# DataMaintenance
+DataMaintenance provides a generator to generate boilerplate of data maintenance for Rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'data_maintenance'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install data_maintenance
+```
+
+## Usage
+
+Run the following generator command, then edit the generated file.
+
+```
+$ rails g data_maintenance set_user_status
+```
+
+You can execute the generated script with the following command
+```
+$ rails r db/maintenances/set_user_status.rb
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kuranari/data_maintenance.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "data_maintenance"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/data_maintenance.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "data_maintenance/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_maintenance"
+  spec.version       = DataMaintenance::VERSION
+  spec.authors       = ["Tomohisa KURANARI"]
+  spec.email         = ["tomohisa.kuranari@gmail.com"]
+
+  spec.summary       = %q{Stubs out a new data maintenance script.}
+  spec.description   = %q{Stubs out a new data maintenance script.}
+  spec.homepage      = "https://github.com/kuranari/data_maintenance"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'railties', '>= 3.0'
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/data_maintenance.rb

@@ -0,0 +1,5 @@
+require "data_maintenance/version"
+
+module DataMaintenance
+  # Your code goes here...
+end

data/lib/data_maintenance/version.rb

@@ -0,0 +1,3 @@
+module DataMaintenance
+  VERSION = "0.1.0"
+end

data/lib/generators/data_maintenance/USAGE

@@ -0,0 +1,11 @@
+Description:
+    Stubs out a new data maintenance script. 
+    Pass the maintenance script name either CamelCased or under_scored.
+
+    A maintenance script is generated in db/maintenances.
+
+Example:
+    rails generate data_maintenance fix_user_name
+
+    This will create:
+        db/maintenances/fix_user_name.rb

data/lib/generators/data_maintenance/data_maintenance_generator.rb

@@ -0,0 +1,10 @@
+class DataMaintenanceGenerator < ::Rails::Generators::NamedBase
+  source_root File.expand_path('templates', __dir__)
+  check_class_collision suffix: "Maintenance"
+
+  def create_data_maintenance_file
+    template "data_maintenance.erb", File.join('db/maintenances', "#{file_name}.rb")
+  end
+
+  hook_for :test_framework
+end

data/lib/generators/data_maintenance/templates/data_maintenance.erb

@@ -0,0 +1,13 @@
+<% module_namespacing do -%>
+class <%= class_name %>Maintenance
+  def self.execute
+    # do something
+  end
+end
+
+realtime = Benchmark.realtime do
+  <%= class_name -%>Maintenance.execute
+end
+puts "realtime: #{realtime}"
+
+<% end -%>

data/lib/generators/rspec/data_maintenance_generator.rb

@@ -0,0 +1,11 @@
+module Rspec
+  module Generators
+    class DataMaintenanceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_data_maintenance_spec
+        template 'data_maintenance_spec.rb', File.join('spec/db/maintenances', "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/generators/rspec/templates/data_maintenance_spec.rb

@@ -0,0 +1,8 @@
+require '<%= File.exists?('spec/rails_helper.rb') ? 'rails_helper' : 'spec_helper' %>'
+require '<%= "./db/maintenances/#{file_name}" -%>'
+
+RSpec.describe <%= class_name %>Maintenance do
+  describe '.execute' do
+    pending "add some examples to (or delete) #{__FILE__}"
+  end
+end

data/lib/generators/test_unit/data_maintenance_generator.rb

@@ -0,0 +1,11 @@
+module TestUnit
+  module Generators
+    class DataMaintenanceGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path('templates', __dir__)
+
+      def create_maintenance_test
+        template 'data_maintenance_test.rb', File.join('test/db/maintenances', "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/lib/generators/test_unit/templates/data_maintenance_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+require '<%= "./db/maintenances/#{file_name}" -%>'
+
+<% module_namespacing do -%>
+class <%= class_name %>MaintenanceTest < ActiveSupport::TestCase
+  test "execute" do
+    flunk "add some examples to (or delete) #{__FILE__}"
+  end
+end
+<% end -%>

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: data_maintenance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomohisa KURANARI
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Stubs out a new data maintenance script.
+email:
+- tomohisa.kuranari@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- data_maintenance.gemspec
+- lib/data_maintenance.rb
+- lib/data_maintenance/version.rb
+- lib/generators/data_maintenance/USAGE
+- lib/generators/data_maintenance/data_maintenance_generator.rb
+- lib/generators/data_maintenance/templates/data_maintenance.erb
+- lib/generators/rspec/data_maintenance_generator.rb
+- lib/generators/rspec/templates/data_maintenance_spec.rb
+- lib/generators/test_unit/data_maintenance_generator.rb
+- lib/generators/test_unit/templates/data_maintenance_test.rb
+homepage: https://github.com/kuranari/data_maintenance
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Stubs out a new data maintenance script.
+test_files: []