schemate 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e09e38daf99bb8d6110644ba081f5395590da85a855b0221e37e1fbd48e9f9d3
+  data.tar.gz: ef5c0210fa124bd84147207edbafea9c4ec2897987b03361aee28f1fac1033f8
+SHA512:
+  metadata.gz: ca3bd184a77bbd785d308317b4e157ecd62438f2c8d7cb26f556e0507b41273fd5b3145b3c274e80681ec393b0ae715adbd53394fc9c4c14a1c456110144160f
+  data.tar.gz: 783da2c32a78c589723d53c0f522f2ad7d0c08eb427a368884e431203fd361fb953a2cd915e5ec14ff4afaf16a85e462dbf180f5f338b46883dd809a2150a840

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at saito@palan.co.jp. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,23 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development, :test do
+  gem 'byebug'
+  gem 'guard-rspec', require: false
+  gem 'rspec', require: false
+
+  gem "rubocop", ">= 0.49.0"
+  gem 'simplecov', require: false
+
+  gem 'codeclimate-test-reporter'
+  gem 'coveralls'
+
+  platforms :mri, :mingw do
+    gem 'pry', require: false
+    gem 'pry-coolline', require: false
+  end
+end
+
+# Specify your gem's dependencies in schemate.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 eishi
+
+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,71 @@
+# Schemate [![Build Status](https://travis-ci.org/eishis/schemate.svg?branch=master)](https://travis-ci.org/eishis/schemate) [![Coverage Status](https://coveralls.io/repos/github/eishis/schemate/badge.svg?branch=master)](https://coveralls.io/github/eishis/schemate?branch=master)
+
+Export current schema of ActiveRecord models as markdown or CSV
+
+The schema list (schemate.md) looks like this:
+```
+# Table name: `users` 
+## Columns
+|FieldName |Attitutde |Size |NULL |Default |Comment |
+|---|---|---|---|---|---|
+|id |integer |8 |false | ||
+|name |string |255 |true | ||
+|email |string |255 |false | ||
+|crypted_password |string |255 |true | ||
+|salt |string |255 |true | ||
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'schemate'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install schemate
+
+## Usage
+
+Export schema to CSV:
+
+    $ bundle exec rake schemate:export_csv
+
+Export schema to Markdown:
+
+    $ bundle exec rake schemate:export_md
+
+## Configuration
+To generate a configuration file(config/initializers/schemate.rb), to set default options:
+
+    $ rails g schemate:install
+
+Edit this file to control auto generation, and output format.
+
+By default, schema is exported only when you run `schemate:export_csv` or `schemate:export_md`.  
+If you want to export schema automatically with `rake db:migrate`, edit the file and change:
+
+    config.auto_generate = true
+
+By default, auto generate file type is markdown.  
+If you want to generate file as csv, edit the file and change:
+
+    config.auto_generate_type = 'csv'
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/palan-inc/schemate. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Schemate project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/palan-inc/schemate/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/SECURITY.md

@@ -0,0 +1,21 @@
+# Security Policy
+
+## Supported Versions
+
+Use this section to tell people about which versions of your project are
+currently being supported with security updates.
+
+| Version | Supported          |
+| ------- | ------------------ |
+| 5.1.x   | :white_check_mark: |
+| 5.0.x   | :x:                |
+| 4.0.x   | :white_check_mark: |
+| < 4.0   | :x:                |
+
+## Reporting a Vulnerability
+
+Use this section to tell people how to report a vulnerability.
+
+Tell them where to go, how often they can expect to get an update on a
+reported vulnerability, what to expect if the vulnerability is accepted or
+declined, etc.

data/lib/generators/schemate/install_generator.rb

@@ -0,0 +1,18 @@
+require 'securerandom'
+
+module Schemate
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+
+
+      desc 'Copy annotate_models rakefiles for automatic annotation'
+      source_root File.expand_path('templates', __dir__)
+
+      # copy rake tasks
+      def copy_tasks
+        template 'schemate.rb', 'config/initializers/schemate.rb'
+      end
+
+    end
+  end
+end

data/lib/generators/schemate/templates/schemate.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+Schemate.configure do |config|
+  # == Auto generate
+  # A schema list is generated automatically when you run rails:db
+  # config.auto_generate = true
+
+  # If you want to export schema as csv. `md` by default
+  # config.auto_generate_type = 'csv'
+end

data/lib/schemate.rb

@@ -0,0 +1,94 @@
+require "schemate/version"
+
+module Schemate
+  if defined?(::Rails::Railtie)
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load "tasks/export_schema.rake"
+        load "tasks/schemate_migrate.rake"
+      end
+    end
+  end
+
+  class << self
+    def export(format:)
+      return if format.nil?
+
+      Rails.application.eager_load!
+      begin
+        export_as(format)
+      rescue StandardError => ex
+        STDERR.puts "Unable to export : #{ex.message}"
+        return
+      end
+      puts_complete_message(format)
+    end
+
+    def export_csv
+      CSV.open('schemate.csv', 'w') do |file|
+        ActiveRecord::Base.descendants.each do |model|
+          model_name = model.name
+          table_name = model_name.tableize
+
+          next unless tables.include?(table_name)
+          file << %W(#{table_name})
+          file << %w(FieldName Attitutde Size NULL Default Index Comment)
+          model.columns.each do |columns|
+            index = 'true' if model.connection.index_exists?(:"#{table_name}", :"#{columns.name}")
+            file << csv_row(columns, index)
+          end
+          file << %w()
+        end
+      end
+    end
+
+    def csv_row(columns, index)
+      %W(
+        #{columns.name} #{columns.type} #{columns.limit}
+        #{columns.null} #{columns.default} #{index} #{columns.comment}
+      )
+    end
+
+    def export_md
+      File.open('schemate.md', 'w') do |file|
+        ActiveRecord::Base.descendants.each do |model|
+          model_name = model.name
+          table_name = model_name.tableize
+
+          next unless tables.include?(table_name)
+          file.puts("# Table name: `#{table_name}`\n")
+          file.puts('## Columns')
+          file.puts('|FieldName |Attitutde |Size |NULL |Default |Index |Comment |')
+          file.puts('|---|---|---|---|---|---|---|')
+          model.columns.each do |columns|
+            index = 'true' if model.connection.index_exists?(:"#{table_name}", :"#{columns.name}")
+            file.puts(md_row(columns, index))
+          end
+          file.puts("\n")
+        end
+      end
+    end
+
+    def md_row(columns, index)
+      "|#{columns.name} |#{columns.type} |#{columns.limit} |#{columns.null} |#{columns.default} |#{index} |#{columns.comment} |"
+    end
+
+    private
+
+    def export_as(format)
+      if format == 'csv'
+        export_csv
+      elsif format == 'md'
+        export_md
+      end
+    end
+
+    def tables
+      @tables ||= ActiveRecord::Base.connection.tables
+    end
+
+    def puts_complete_message(format)
+      puts "complete! See schemate.#{format}!"
+    end
+  end
+end

data/lib/schemate/config.rb

@@ -0,0 +1,21 @@
+require 'active_support/configurable'
+module Schemate
+  def self.configure(&block)
+    yield @config ||= Schemate::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    include ActiveSupport::Configurable
+    config_accessor :auto_generate
+    config_accessor :auto_generate_type
+  end
+
+  configure do |config|
+    config.auto_generate = false
+    config.auto_generate_type = 'md'
+  end
+end

data/lib/schemate/version.rb

@@ -0,0 +1,3 @@
+module Schemate
+  VERSION = "0.1.1"
+end

data/lib/tasks/export_schema.rake

@@ -0,0 +1,13 @@
+require 'csv'
+
+namespace :schemate do
+  desc 'Create CSV file from schema information'
+  task export_csv: :environment do
+    Schemate.export(format: 'csv')
+  end
+
+  desc 'Create Markdown file from schema information'
+  task export_md: :environment do
+    Schemate.export(format: 'md')
+  end
+end

data/lib/tasks/schemate_migrate.rake

@@ -0,0 +1,25 @@
+require "schemate/config"
+
+namespace :db do
+  [:migrate, :rollback].each do |cmd|
+    task cmd do
+      if Schemate.config.auto_generate_type == 'md'
+        Rake::Task['schemate:export_md'].invoke if Schemate.config.auto_generate
+      elsif Schemate.config.auto_generate_type == 'csv'
+        Rake::Task['schemate:export_csv'].invoke if Schemate.config.auto_generate
+      end
+    end
+
+    namespace cmd do
+      [:change, :up, :down, :reset, :redo].each do |t|
+        task t do
+          if Schemate.config.auto_generate_type == 'md'
+            Rake::Task['schemate:export_md'].invoke if Schemate.config.auto_generate
+          elsif Schemate.config.auto_generate_type == 'csv'
+            Rake::Task['schemate:export_csv'].invoke if Schemate.config.auto_generate
+          end
+        end
+      end
+    end
+  end
+end

data/schemate.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schemate/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schemate"
+  spec.version       = Schemate::VERSION
+  spec.authors       = ["eishisaito", "yuh-pen", "TomoroKobori"]
+  spec.email         = ["saito@palan.co.jp"]
+
+  spec.summary       = 'Export Schema Data as CSV and Markdown format'
+  spec.description   = 'Export Schema Data as CSV and Markdown format'
+  spec.homepage      = 'https://github.com/palan-inc/schemate'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "coveralls"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: schemate
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- eishisaito
+- yuh-pen
+- TomoroKobori
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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'
+description: Export Schema Data as CSV and Markdown format
+email:
+- saito@palan.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- SECURITY.md
+- lib/generators/schemate/install_generator.rb
+- lib/generators/schemate/templates/schemate.rb
+- lib/schemate.rb
+- lib/schemate/config.rb
+- lib/schemate/version.rb
+- lib/tasks/export_schema.rake
+- lib/tasks/schemate_migrate.rake
+- schemate.gemspec
+homepage: https://github.com/palan-inc/schemate
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Export Schema Data as CSV and Markdown format
+test_files: []