r2-oas 0.4.0

data/lib/r2-oas/tool/paths/stats.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'terminal-table'
+require 'paint'
+require 'forwardable'
+
+module R2OAS
+  module Tool
+    module Paths
+      class Stats < Base
+        extend Forwardable
+
+        TIMESTAMPS = ['Created At', 'Updated At'].freeze
+        TABLE_TITLE = 'Paths Stats'
+
+        def initialize(options = {})
+          super
+          @paths_list = Dir.glob("#{schema_save_dir_path}/paths/**/**.yml")
+          @path_from = Pathname(File.dirname(File.expand_path(root_dir_path)))
+          @paths_stats = tool.paths_stats
+        end
+
+        def print
+          table.title = Paint[TABLE_TITLE, table_title_color]
+          puts table
+          puts "\n#{Paint['Red', warning_color]}: over #{month_to_turn_to_warning_color} months since the last update."
+        end
+
+        private
+
+        def_delegators :@paths_stats, :month_to_turn_to_warning_color, :warning_color, :table_title_color, :heading_color, :highlight_color
+
+        def table
+          @table ||= Terminal::Table.new do |t|
+            @paths_list.each_with_index do |file_path, index|
+              t.headings = ['No', 'File Path', *TIMESTAMPS].map { |head| Paint[head, heading_color] }
+              t << table_content(index, file_path)
+              t.style = { all_separators: true }
+            end
+          end
+        end
+
+        def table_content(index, file_path)
+          content = [(index + 1).to_s, relative_file_path(file_path), *timestamps(file_path)]
+          if file_path.in? paths_config.many_paths_file_paths
+            content.map { |c| Paint[c, highlight_color] }
+          else
+            content
+          end
+        end
+
+        def relative_file_path(file_path)
+          path_to = Pathname(file_path)
+          path_to.relative_path_from(@path_from).to_s
+        end
+
+        def timestamps(file_path)
+          timestamps_data(file_path) do |result, stat|
+            mtime = stat.mtime
+            result.deep_merge!(
+              mtime: expired?(mtime) ? Paint[mtime, warning_color] : mtime
+            )
+          end.values
+        end
+
+        def timestamps_data(file_path)
+          stat = File::Stat.new(file_path)
+          result = {
+            birthtime: stat.birthtime,
+            mtime: stat.mtime
+          }
+          yield result, stat if block_given?
+          result
+        end
+
+        def expired?(mtime)
+          month = month_to_turn_to_warning_color.send(:month)
+          expired_at = Time.current.ago(month)
+          mtime < expired_at
+        end
+      end
+    end
+  end
+end

data/lib/r2-oas/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module R2OAS
+  VERSION = '0.4.0'
+end

data/r2-oas.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'r2-oas/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'r2-oas'
+  spec.version       = R2OAS::VERSION
+  spec.authors       = ['yukihirop']
+  spec.email         = ['te108186@gmail.com']
+
+  spec.summary       = 'Provide rake tasks to management API Docment (OpenAPI)'
+  spec.description   = %Q{== Let's intuitively write API documentation with Swagger Editor in your Rails Project! 😊\n#{IO.read('GEMSPEC.md')}}
+
+  spec.homepage      = 'https://github.com/yukihirop/r2-oas'
+  spec.license       = 'MIT'
+  spec.metadata = {
+    "bug_tracker_uri"   => "https://github.com/yukihirop/r2-oas/issues",
+    "changelog_uri"     => "https://github.com/yukihirop/r2-oas/blob/v#{spec.version}/CHANGELOG.md",
+    "documentation_uri" => "https://yukihirop.github.io/r2-oas",
+    "source_code_uri"   => "https://github.com/yukihirop/r2-oas/tree/v#{spec.version}"
+  }
+
+  # Specify which files should be added to the gem when it is released.
+  spec.files         = Dir["CHANGELOG.md", "GEMSPEC.md", "README.md", "README.ja.md", "LICENSE.txt", "lib/**/*", "r2-oas.gemspec"]
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.3p222')
+
+  spec.add_runtime_dependency 'docker-api', '>= 1.34.2'
+  spec.add_runtime_dependency 'easy_diff', '>= 1.0.0'
+  spec.add_runtime_dependency 'eventmachine', '>= 1.2.0'
+  spec.add_runtime_dependency 'key_flatten', '>= 1.0.0'
+  spec.add_runtime_dependency 'paint'
+  spec.add_runtime_dependency 'railties', '>= 4.2.5'
+  spec.add_runtime_dependency 'terminal-table', '>= 1.6.0'
+  spec.add_runtime_dependency 'watir', '>= 6.16.5'
+  spec.add_development_dependency 'bundler', '>= 1.17'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'activerecord', '>= 4.2.5'
+end

metadata

@@ -0,0 +1,415 @@
+--- !ruby/object:Gem::Specification
+name: r2-oas
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- yukihirop
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docker-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.34.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.34.2
+- !ruby/object:Gem::Dependency
+  name: easy_diff
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: key_flatten
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.16.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.16.5
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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'
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.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: rubocop
+  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: appraisal
+  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.2.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.5
+description: "== Let's intuitively write API documentation with Swagger Editor in
+  your Rails Project! \U0001F60A\nConfigureless and no DSL. \U0001F44D But you can
+  also configure.  \nManage with yaml file instead of Ruby code.  \nLoosely coupled
+  to your Rails project. \U0001F44D  \nSo if you want to use another tool, you can
+  port it right away. \U0001F622  \nGenerate api docment(OpenAPI) side only from `Rails`
+  routing.  \n  \nProvide rake tasks to management API Docment (OpenAPI) \U0001F389
+  \ \n  \n    $ bundle exec rake routes:oas:init\n    $ bundle exec rake routes:oas:docs\n
+  \   $ bundle exec rake routes:oas:ui\n    $ bundle exec rake routes:oas:editor\n
+  \   $ bundle exec rake routes:oas:monitor\n    $ bundle exec rake routes:oas:build\n
+  \   $ bundle exec rake routes:oas:clean\n    $ bundle exec rake routes:oas:analyze\n
+  \   $ bundle exec rake routes:oas:deploy\n\n  \nHappy Coding ❗️\n"
+email:
+- te108186@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- GEMSPEC.md
+- LICENSE.txt
+- README.ja.md
+- README.md
+- lib/r2-oas.rb
+- lib/r2-oas/app_configuration.rb
+- lib/r2-oas/app_configuration/deprecation.rb
+- lib/r2-oas/app_configuration/server.rb
+- lib/r2-oas/app_configuration/swagger.rb
+- lib/r2-oas/app_configuration/swagger/editor.rb
+- lib/r2-oas/app_configuration/swagger/ui.rb
+- lib/r2-oas/app_configuration/tool.rb
+- lib/r2-oas/app_configuration/tool/paths/stats.rb
+- lib/r2-oas/base.rb
+- lib/r2-oas/configuration.rb
+- lib/r2-oas/configuration/paths_config.rb
+- lib/r2-oas/deploy/client.rb
+- lib/r2-oas/deploy/swagger-ui/index.html.erb
+- lib/r2-oas/dynamic/schema/v3/object/from_routes/hookable_base_object.rb
+- lib/r2-oas/errors.rb
+- lib/r2-oas/hooks/global_hook.rb
+- lib/r2-oas/hooks/hook.rb
+- lib/r2-oas/hooks/repository.rb
+- lib/r2-oas/lib/core_ext/hash/deep_merge.rb
+- lib/r2-oas/lib/core_ext/object/blank.rb
+- lib/r2-oas/lib/three-way-merge/twm.rb
+- lib/r2-oas/logger/stdout_logger.rb
+- lib/r2-oas/pluggable_configuration.rb
+- lib/r2-oas/plugin/base.rb
+- lib/r2-oas/plugin/executor.rb
+- lib/r2-oas/plugin/hookable.rb
+- lib/r2-oas/plugin/public.rb
+- lib/r2-oas/plugin/transform/transform.rb
+- lib/r2-oas/plugin/transform/v3/transform.rb
+- lib/r2-oas/plugin/transform/v3/visitable.rb
+- lib/r2-oas/public.rb
+- lib/r2-oas/routing/adjustor.rb
+- lib/r2-oas/routing/base.rb
+- lib/r2-oas/routing/components/all.rb
+- lib/r2-oas/routing/components/base_component.rb
+- lib/r2-oas/routing/components/path_component.rb
+- lib/r2-oas/routing/components/request_component.rb
+- lib/r2-oas/routing/components/verb_component.rb
+- lib/r2-oas/routing/parser.rb
+- lib/r2-oas/schema/analyzer.rb
+- lib/r2-oas/schema/base.rb
+- lib/r2-oas/schema/builder.rb
+- lib/r2-oas/schema/cleaner.rb
+- lib/r2-oas/schema/editor.rb
+- lib/r2-oas/schema/generator.rb
+- lib/r2-oas/schema/manager/file/path_item_file_manager.rb
+- lib/r2-oas/schema/manager/file_manager.rb
+- lib/r2-oas/schema/monitor.rb
+- lib/r2-oas/schema/squeezer.rb
+- lib/r2-oas/schema/ui.rb
+- lib/r2-oas/schema/v3/analyzer.rb
+- lib/r2-oas/schema/v3/analyzer/base_analyzer.rb
+- lib/r2-oas/schema/v3/analyzer/components/object_analyzer.rb
+- lib/r2-oas/schema/v3/analyzer/components_analyzer.rb
+- lib/r2-oas/schema/v3/analyzer/path_analyzer.rb
+- lib/r2-oas/schema/v3/analyzer/tag_analyzer.rb
+- lib/r2-oas/schema/v3/base.rb
+- lib/r2-oas/schema/v3/builder.rb
+- lib/r2-oas/schema/v3/builder/base_builder.rb
+- lib/r2-oas/schema/v3/builder/doc_builder.rb
+- lib/r2-oas/schema/v3/cleaner.rb
+- lib/r2-oas/schema/v3/cleaner/base_cleaner.rb
+- lib/r2-oas/schema/v3/cleaner/components_cleaner.rb
+- lib/r2-oas/schema/v3/generator.rb
+- lib/r2-oas/schema/v3/generator/base_generator.rb
+- lib/r2-oas/schema/v3/generator/components/object_generator.rb
+- lib/r2-oas/schema/v3/generator/components/request_body_generator.rb
+- lib/r2-oas/schema/v3/generator/components_generator.rb
+- lib/r2-oas/schema/v3/generator/doc_generator.rb
+- lib/r2-oas/schema/v3/generator/path_generator.rb
+- lib/r2-oas/schema/v3/generator/schema_generator.rb
+- lib/r2-oas/schema/v3/manager/diff/base_array_diff_manager.rb
+- lib/r2-oas/schema/v3/manager/diff/base_diff_manager.rb
+- lib/r2-oas/schema/v3/manager/diff/base_hash_diff_manager.rb
+- lib/r2-oas/schema/v3/manager/diff/components_diff_manager.rb
+- lib/r2-oas/schema/v3/manager/diff/tag_diff_manager.rb
+- lib/r2-oas/schema/v3/manager/file/base_file_manager.rb
+- lib/r2-oas/schema/v3/manager/file/components_file_manager.rb
+- lib/r2-oas/schema/v3/manager/file/include_ref_base_file_manager.rb
+- lib/r2-oas/schema/v3/manager/file/path_item_file_manager.rb
+- lib/r2-oas/schema/v3/manager/file_manager.rb
+- lib/r2-oas/schema/v3/manager/pathname_manager.rb
+- lib/r2-oas/schema/v3/object/from_files/base_object.rb
+- lib/r2-oas/schema/v3/object/from_files/components/request_body_object.rb
+- lib/r2-oas/schema/v3/object/from_files/components/schema_object.rb
+- lib/r2-oas/schema/v3/object/from_files/components_object.rb
+- lib/r2-oas/schema/v3/object/from_files/external_document_object.rb
+- lib/r2-oas/schema/v3/object/from_files/info_object.rb
+- lib/r2-oas/schema/v3/object/from_files/openapi_object.rb
+- lib/r2-oas/schema/v3/object/from_files/path_item_object.rb
+- lib/r2-oas/schema/v3/object/from_files/paths_object.rb
+- lib/r2-oas/schema/v3/object/from_files/utils/all.rb
+- lib/r2-oas/schema/v3/object/from_files/utils/deep_methods.rb
+- lib/r2-oas/schema/v3/object/from_files/utils/refs.rb
+- lib/r2-oas/schema/v3/object/from_routes/base_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/components/request_body_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/components/schema_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/components_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/external_document_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/info_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/openapi_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/path_item_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/paths_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/public.rb
+- lib/r2-oas/schema/v3/object/from_routes/server_object.rb
+- lib/r2-oas/schema/v3/object/from_routes/tag_object.rb
+- lib/r2-oas/schema/v3/object/store.rb
+- lib/r2-oas/schema/v3/squeezer.rb
+- lib/r2-oas/schema/v3/squeezer/base_squeezer.rb
+- lib/r2-oas/schema/v3/squeezer/path_squeezer.rb
+- lib/r2-oas/schema/v3/squeezer/tag_squeezer.rb
+- lib/r2-oas/shared/all.rb
+- lib/r2-oas/shared/callable.rb
+- lib/r2-oas/shared/sortable.rb
+- lib/r2-oas/store.rb
+- lib/r2-oas/support/deprecation.rb
+- lib/r2-oas/support/deprecation/behavior.rb
+- lib/r2-oas/support/deprecation/instance_delegator.rb
+- lib/r2-oas/support/deprecation/reporting.rb
+- lib/r2-oas/task.rb
+- lib/r2-oas/task_logging.rb
+- lib/r2-oas/tasks/common.rake
+- lib/r2-oas/tasks/main.rake
+- lib/r2-oas/tasks/tool.rake
+- lib/r2-oas/tool/paths/ls.rb
+- lib/r2-oas/tool/paths/stats.rb
+- lib/r2-oas/version.rb
+- r2-oas.gemspec
+homepage: https://github.com/yukihirop/r2-oas
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/yukihirop/r2-oas/issues
+  changelog_uri: https://github.com/yukihirop/r2-oas/blob/v0.4.0/CHANGELOG.md
+  documentation_uri: https://yukihirop.github.io/r2-oas
+  source_code_uri: https://github.com/yukihirop/r2-oas/tree/v0.4.0
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.3p222
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Provide rake tasks to management API Docment (OpenAPI)
+test_files: []