strict-todo 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 734ac657716c363d1d1625a0427d5b7721516304d282ec012e5b799e0924591e
+  data.tar.gz: 5c1f5f89c2e79123259b10a72f11c7afe3b39a50e2e59e98e732865156d5487a
+SHA512:
+  metadata.gz: b6185c032adf9e21f0fb905bc41bfee5aeefebf8c3a55788a343895f8fe75d28918ad288ec280a2f381ad015babd6f9d1d54dcf038600a29ec3f36b9464073bc
+  data.tar.gz: 4bbcc03ecbaeb479db8edbf92b561487e4114e443474401d636998c4bc808a751968ea253127cd4426ed1f5e1b8cd4273e0f86bc5ddd616459308d6088c9aed3

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.7
+        bundle install
+        bundle exec rake

data/.gitignore

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

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+3.0.0

data/Gemfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in strict_todo.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 tunagohan
+
+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,39 @@
+# Strict::Todo
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/strict/todo`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strict-todo'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install strict-todo
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 the created tag, 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/[USERNAME]/strict-todo.
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[spec]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require_relative "../lib/strict_todo"
+
+# 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/config/config.yml

@@ -0,0 +1,16 @@
+common:
+  exclude:
+    - 'node_modules'
+    - 'tmp'
+    - 'vendor'
+    - '.git'
+    - 'Gemfile.lock'
+    - 'lib'
+    - 'db'
+  extension:
+    - '.rb'
+    - '.erb'
+    - '.vue'
+    - '.css'
+    - '.scss'
+    - ''

data/exe/todo

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+#
+# TODO: やることリストを洗い出す
+
+require_relative "../lib/strict_todo/executable"
+
+StrictTodo::Executable.perform

data/lib/strict_todo.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module StrictTodo
+end

data/lib/strict_todo/checker.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'date'
+
+module StrictTodo
+  class Checker
+    class << self
+      def perform(line:)
+        delete_index = line.index('TODO') || line.index('FIXME')
+        return nil if delete_index.nil?
+
+        parse_line = line.slice(delete_index..)
+
+        unless delete_index.zero?
+          line.slice!(0..delete_index-1)
+        end
+
+        if check_format(line: parse_line).nil?
+          return "フォーマットエラー"
+        end
+
+        date = parse_line.match(/[0-9]{4}\/(0[1-9]|1[0-2])\/(0[1-9]|[12][0-9]|3[01])/)[0]
+        if check_date(date: date)
+          return "期限を過ぎています"
+        end
+
+        nil
+      end
+
+      private
+
+      def check_format(line:)
+        line =~ /\A(TODO|FIXME)\((\w|-)*:[0-9]{4}\/(0[1-9]|1[0-2])\/(0[1-9]|[12][0-9]|3[01])\).*\Z/
+      end
+
+      def check_date(date:)
+        Date.parse(date) < Date.today
+      end
+    end
+  end
+end

data/lib/strict_todo/config.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module StrictTodo
+  class Config
+    private_class_method :new
+
+    COMMON = YAML.safe_load(File.read("config/config.yml")).fetch("common").freeze
+
+    # @return [Array] 除外対象
+    attr_reader :exclude_match
+    # @return [Array] 検索対象の拡張子
+    attr_reader :permit_extensions
+
+    def initialize
+      @exclude_match = COMMON.fetch("exclude")
+      @permit_extensions = COMMON.fetch("extension")
+    end
+
+    class << self
+      def load
+        return new.freeze()
+      end
+    end
+  end
+end

data/lib/strict_todo/executable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'config'
+require_relative 'find_file'
+require_relative 'find_word'
+require_relative 'checker'
+
+
+
+module StrictTodo
+  class Executable
+    private_class_method :new
+
+    class << self
+      def perform
+        results = {}
+
+        config = StrictTodo::Config.load
+        files = StrictTodo::FindFile.perform(config: config, base_dir: '.')
+
+        files.each do |file|
+          results.update(StrictTodo::FindWord.perform(file_path: file))
+        end
+
+        results.each_key do |key|
+          error = StrictTodo::Checker.perform(line: results[key][:description])
+          results[key][:error] = error
+        end
+
+        output(objects: results)
+      end
+
+      private
+
+      def output(objects:)
+        objects.each_key do |key|
+          if objects[key][:error].nil?
+            puts "#{objects[key][:header]} \e[1m\e[32mSuccess\e[0m\n=> #{objects[key][:description]}\n\e[0m"
+          else
+            puts "#{objects[key][:header]} \e[1m\e[31m#{objects[key][:error]}\e[0m\n=> #{objects[key][:description]}\n\e[0m"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/strict_todo/find_file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module StrictTodo
+  class FindFile
+    private_class_method :new
+
+    class << self
+      #
+      # @param [StrictTodo::Config] config YamlロードされHash化されたConfig情報
+      # @param [String] base_dir 起点となるディレクトリ
+      #
+      # @return [Array<String>] ファイルのパス情報
+      #
+      def perform(config:, base_dir:)
+        results = []
+        Dir.glob('**/*', File::FNM_DOTMATCH, base: base_dir) do |path|
+          # ディレクトリならば更に再起探索を行う
+          if File.directory?(path)
+            next
+          end
+
+          if acceptable?(dir_path: path, config: config)
+            results.push(path)
+          end
+        end
+        results
+      end
+
+      private
+
+      #
+      # @param [String] dir_path ディレクトリパス
+      # @param [StrictTodo::Config] config YamlロードされHash化されたConfig情報
+      #
+      def acceptable?(dir_path:, config:)
+        return false if not config.permit_extensions.include?(File.extname(dir_path))
+        return false if config.exclude_match.include?(dir_path.split("/").first)
+
+        true
+      end
+    end
+  end
+end

data/lib/strict_todo/find_word.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module StrictTodo
+  class FindWord
+    private_class_method :new
+
+    class << self
+      def perform(file_path:)
+        results = {}
+        File.readlines(file_path, chomp: true).each.with_index(1) do |line, index|
+          if line.include?('TODO')
+            results["#{file_path}:#{index.to_s}"] = {
+              header: extraction_todo(file_path: file_path, index: index),
+              description: line
+            }
+          end
+
+          if line.include?('FIXME')
+            results["#{file_path}:#{index.to_s}"] = {
+              header: extraction_fixme(file_path: file_path, index: index),
+              description: line
+            }
+          end
+        end
+        results
+      end
+
+      private
+
+      def extraction_todo(file_path:, index:)
+        "TODO(#{file_path}:#{index})"
+      end
+
+      def extraction_fixme(file_path:, index:)
+        "FIXME(#{file_path}:#{index})"
+      end
+    end
+  end
+end

data/lib/strict_todo/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module StrictTodo
+  VERSION = "0.0.1"
+end

data/strict_todo.gemspec

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "lib/strict_todo/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "strict-todo"
+  spec.version       = StrictTodo::VERSION
+  spec.authors       = ["tunagohan"]
+  spec.email         = ["kazuxtuna@gmail.com"]
+
+  spec.summary       = "Strict to do management."
+  spec.description   = "Strict to do management. Have them describe who will do what by when. This is to avoid leaving meaningless to do."
+  spec.homepage      = "https://github.com/tunagohan/strict-todo"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: strict-todo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- tunagohan
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-01-29 00:00:00.000000000 Z
+dependencies: []
+description: Strict to do management. Have them describe who will do what by when.
+  This is to avoid leaving meaningless to do.
+email:
+- kazuxtuna@gmail.com
+executables:
+- todo
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/config.yml
+- exe/todo
+- lib/strict_todo.rb
+- lib/strict_todo/checker.rb
+- lib/strict_todo/config.rb
+- lib/strict_todo/executable.rb
+- lib/strict_todo/find_file.rb
+- lib/strict_todo/find_word.rb
+- lib/strict_todo/version.rb
+- strict_todo.gemspec
+homepage: https://github.com/tunagohan/strict-todo
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.3
+signing_key:
+specification_version: 4
+summary: Strict to do management.
+test_files: []