csvcop 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: ab81a0aff29f872587a8695620b8c1722c3371a78ae8215a5191f83d2f8f0907
4
+ data.tar.gz: 904fbfeb4d372e0bcb8c3322c3aec6c807a9d5f4432698cdc40aad9c048e936c
5
+ SHA512:
6
+ metadata.gz: 5dbc01278063d78dcdae7ee6ace90f0ebbdf2d779e292c0589639b48c6d932e3682333ac24685bfb1ddbb61f0d5bd8ac53f32fc4606c3ba28ac6013d817a1caf
7
+ data.tar.gz: 8620149ab77ad933b4d031ad09103e0dbc50e61dfe01875c0445f7acd891997731d5347aab2f81b067c42fa8cb54e197ad1fba7e155172a8adebb3d8ada0390c
@@ -0,0 +1,14 @@
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+
10
+ # rspec failure tracking
11
+ .rspec_status
12
+ /vendor/bundle
13
+ .dev.csvcop.yaml
14
+ dev.csv
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
@@ -0,0 +1,6 @@
1
+ ---
2
+ language: ruby
3
+ cache: bundler
4
+ rvm:
5
+ - 2.7.0
6
+ before_install: gem install bundler -v 2.1.4
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at j.o.lantern0422@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,16 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in csvcop.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "rspec", "~> 3.0"
8
+ gem "thor"
9
+ gem "yaml"
10
+ gem "csv"
11
+ gem 'activesupport'
12
+
13
+ group "development" do
14
+ gem "byebug"
15
+ gem "pry"
16
+ end
@@ -0,0 +1,63 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ csvcop (0.1.0)
5
+
6
+ GEM
7
+ remote: https://rubygems.org/
8
+ specs:
9
+ activesupport (6.0.3)
10
+ concurrent-ruby (~> 1.0, >= 1.0.2)
11
+ i18n (>= 0.7, < 2)
12
+ minitest (~> 5.1)
13
+ tzinfo (~> 1.1)
14
+ zeitwerk (~> 2.2, >= 2.2.2)
15
+ byebug (11.1.3)
16
+ coderay (1.1.2)
17
+ concurrent-ruby (1.1.6)
18
+ csv (3.1.2)
19
+ diff-lcs (1.3)
20
+ i18n (1.8.2)
21
+ concurrent-ruby (~> 1.0)
22
+ method_source (1.0.0)
23
+ minitest (5.14.1)
24
+ pry (0.13.1)
25
+ coderay (~> 1.1)
26
+ method_source (~> 1.0)
27
+ rake (12.3.3)
28
+ rspec (3.9.0)
29
+ rspec-core (~> 3.9.0)
30
+ rspec-expectations (~> 3.9.0)
31
+ rspec-mocks (~> 3.9.0)
32
+ rspec-core (3.9.2)
33
+ rspec-support (~> 3.9.3)
34
+ rspec-expectations (3.9.2)
35
+ diff-lcs (>= 1.2.0, < 2.0)
36
+ rspec-support (~> 3.9.0)
37
+ rspec-mocks (3.9.1)
38
+ diff-lcs (>= 1.2.0, < 2.0)
39
+ rspec-support (~> 3.9.0)
40
+ rspec-support (3.9.3)
41
+ thor (1.0.1)
42
+ thread_safe (0.3.6)
43
+ tzinfo (1.2.7)
44
+ thread_safe (~> 0.1)
45
+ yaml (0.1.0)
46
+ zeitwerk (2.3.0)
47
+
48
+ PLATFORMS
49
+ ruby
50
+
51
+ DEPENDENCIES
52
+ activesupport
53
+ byebug
54
+ csv
55
+ csvcop!
56
+ pry
57
+ rake (~> 12.0)
58
+ rspec (~> 3.0)
59
+ thor
60
+ yaml
61
+
62
+ BUNDLED WITH
63
+ 2.1.4
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2020 j-o-lantern0422
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
@@ -0,0 +1,44 @@
1
+ # csvcop
2
+
3
+ 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/csvcop`. To experiment with that code, run `bin/console` for an interactive prompt.
4
+
5
+ TODO: Delete this and the text above, and describe your gem
6
+
7
+ ## Installation
8
+
9
+ Add this line to your application's Gemfile:
10
+
11
+ ```ruby
12
+ gem 'csvcop'
13
+ ```
14
+
15
+ And then execute:
16
+
17
+ $ bundle install
18
+
19
+ Or install it yourself as:
20
+
21
+ $ gem install csvcop
22
+
23
+ ## Usage
24
+
25
+ TODO: Write usage instructions here
26
+
27
+ ## Development
28
+
29
+ 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.
30
+
31
+ 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).
32
+
33
+ ## Contributing
34
+
35
+ Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/csvcop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/csvcop/blob/master/CODE_OF_CONDUCT.md).
36
+
37
+
38
+ ## License
39
+
40
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
41
+
42
+ ## Code of Conduct
43
+
44
+ Everyone interacting in the csvcop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/csvcop/blob/master/CODE_OF_CONDUCT.md).
@@ -0,0 +1,6 @@
1
+ require "bundler/gem_tasks"
2
+ require "rspec/core/rake_task"
3
+
4
+ RSpec::Core::RakeTask.new(:spec)
5
+
6
+ task :default => :spec
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "csvcop"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
@@ -0,0 +1,8 @@
1
+ AllCops:
2
+ MultiCaracterDelimiter: false
3
+ Delimiter: ","
4
+ Header: true
5
+ NotUsedColumn: false
6
+ DeplicatedElementInOneColumn:
7
+ Enable: true
8
+
@@ -0,0 +1,29 @@
1
+ require_relative 'lib/csvcop/version'
2
+
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "csvcop"
5
+ spec.version = CsvCop::VERSION
6
+ spec.authors = ["j-o-lantern0422"]
7
+ spec.email = ["j.o.lantern0422@gmail.com"]
8
+
9
+ spec.summary = %q{csv linter like rubocop}
10
+ spec.description = %q{csv linter and autofixer like rubocop}
11
+ spec.homepage = "https://jolantern.mugcup.xyz"
12
+ spec.license = "MIT"
13
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
14
+
15
+ spec.metadata["allowed_push_host"] = "https://rubygems.org"
16
+
17
+ spec.metadata["homepage_uri"] = spec.homepage
18
+ spec.metadata["source_code_uri"] = "https://github.com/j-o-lantern0422/csvcop"
19
+ spec.metadata["changelog_uri"] = "https://github.com/j-o-lantern0422/csvcop"
20
+
21
+ # Specify which files should be added to the gem when it is released.
22
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
23
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
24
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
25
+ end
26
+ spec.bindir = "exe"
27
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
28
+ spec.require_paths = ["lib"]
29
+ end
@@ -0,0 +1,5 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "csvcop"
4
+
5
+ CsvCop::Cli.start
@@ -0,0 +1,12 @@
1
+ require_relative "csvcop/version"
2
+ require_relative "csvcop/cli"
3
+ require_relative "csvcop/error"
4
+ require_relative "csvcop/config_loader"
5
+ require_relative "csvcop/config"
6
+ require_relative "csvcop/cop"
7
+ require_relative "csvcop/cop/uniq_column"
8
+
9
+ require "byebug"
10
+
11
+ module CsvCop
12
+ end
@@ -0,0 +1,16 @@
1
+ require "csvcop"
2
+ require "thor"
3
+ require "csv"
4
+
5
+ module CsvCop
6
+ class Cli < Thor
7
+ desc "csvcop {CSV File Path} {options}", "check csv file"
8
+ option "config", aliases: "-c", type: :string
9
+ def csvcop(csv_file_path)
10
+ config = CsvCop::Config.new(options[:config]).read
11
+ csv = CSV.table(csv_file_path)
12
+ cop = CsvCop::Cop::Cop.new(csv, config)
13
+ cop.on_ensure_all
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,17 @@
1
+ require 'active_support/core_ext'
2
+ module CsvCop
3
+ class Config
4
+ def initialize(config=nil)
5
+ conf = CsvCop::ConfigLoader.new(config).load
6
+ @config = conf.deep_symbolize_keys
7
+ end
8
+
9
+ def read
10
+ @config
11
+ end
12
+
13
+ def header?
14
+ @config[:AllCops][:Header]
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,38 @@
1
+ require "yaml"
2
+ require "pathname"
3
+
4
+ module CsvCop
5
+ class ConfigNotFoundError < Error ; end
6
+
7
+ class ConfigLoader
8
+ DOTFILE = '.csvcop.yml'
9
+ CSVCOP_HOME = File.realpath(File.join(File.dirname(__FILE__), '..', '..'))
10
+ DEFAULT_FILE = File.join(CSVCOP_HOME, 'config', 'default.yml')
11
+
12
+ def initialize(rule_file_path=nil)
13
+ unless rule_file_path.nil?
14
+ raise ConfigNotFoundError unless File.exist?(rule_file_path)
15
+ @original_rule = YAML.load_file(rule_file_path)
16
+ end
17
+ @rule = YAML.load_file(DEFAULT_FILE)
18
+ end
19
+
20
+ def load
21
+ return @rule if @original_rule.nil?
22
+ merge_yaml(@rule, @original_rule)
23
+ end
24
+
25
+ private
26
+
27
+ def merge_yaml(yaml1, yaml2)
28
+ yaml2.each do |k, v|
29
+ if v.class == Hash && yaml1.key?(k)
30
+ yaml1[k] = merge_yaml(yaml1[k], v)
31
+ else
32
+ yaml1[k] = v
33
+ end
34
+ end
35
+ return yaml1
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,29 @@
1
+ module CsvCop
2
+ module Cop
3
+ class CopError < Error ; end
4
+
5
+ class Cop
6
+ def initialize(csv, config)
7
+ @csv = csv
8
+ @config = config
9
+ @cops = []
10
+ if CsvCop::Cop::Lint::DeplicatedElementInOneColumn.enable?(@config)
11
+ @cops.push(CsvCop::Cop::Lint::DeplicatedElementInOneColumn.new(@csv, @config))
12
+ end
13
+ @msg = "CsvCop ensure offences.\n"
14
+ end
15
+
16
+ def on_ensure_all
17
+ @cops.each do | cop |
18
+ result = cop.run
19
+
20
+ if result
21
+ @msg.concat(result)
22
+ end
23
+ end
24
+
25
+ puts @msg
26
+ end
27
+ end
28
+ end
29
+ end
@@ -0,0 +1,58 @@
1
+ module CsvCop
2
+ module Cop
3
+ module Lint
4
+ class DeplicatedElementInOneColumn < Cop
5
+ MSG = 'Column is must uniq element.'
6
+
7
+ def initialize(csv, config)
8
+ @csv = csv
9
+ @config = config
10
+ end
11
+
12
+ def self.enable?(config)
13
+ config[:AllCops][config_key][:Enable]
14
+ end
15
+
16
+ def self.config_key
17
+ self.name.split("::").last.to_sym
18
+ end
19
+
20
+ def run
21
+ return false unless DeplicatedElementInOneColumn.enable?(@config)
22
+ on_ensure
23
+ end
24
+
25
+ private
26
+ def on_ensure
27
+ msg = ensure_deplicated_elementes
28
+ unless msg.empty?
29
+ return "ununiqness element.\n#{msg}"
30
+ end
31
+
32
+ false
33
+ end
34
+
35
+ def ensure_deplicated_elementes
36
+ msg = ""
37
+ by_col_csv = @csv.by_col
38
+ by_col_csv.each_with_index do | col, col_index |
39
+ uniq_col = col.flatten.map{|v| v.to_s}.uniq
40
+ col = stringify_values(col.flatten)
41
+
42
+ uniq_col.each do | uniq_col_row |
43
+ if col.count(uniq_col_row) > 1
44
+ msg.concat("column number:#{col_index}, #{uniq_col_row} is deplicated.\n")
45
+ end
46
+ end
47
+ end
48
+
49
+ msg
50
+ end
51
+
52
+ def stringify_values(array)
53
+ array.map{|v| v.to_s}
54
+ end
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,3 @@
1
+ module CsvCop
2
+ class Error < StandardError ; end
3
+ end
@@ -0,0 +1,3 @@
1
+ module CsvCop
2
+ VERSION = "0.1.0"
3
+ end
metadata ADDED
@@ -0,0 +1,70 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: csvcop
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - j-o-lantern0422
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2020-05-17 00:00:00.000000000 Z
12
+ dependencies: []
13
+ description: csv linter and autofixer like rubocop
14
+ email:
15
+ - j.o.lantern0422@gmail.com
16
+ executables:
17
+ - csvcop
18
+ extensions: []
19
+ extra_rdoc_files: []
20
+ files:
21
+ - ".gitignore"
22
+ - ".rspec"
23
+ - ".travis.yml"
24
+ - CODE_OF_CONDUCT.md
25
+ - Gemfile
26
+ - Gemfile.lock
27
+ - LICENSE.txt
28
+ - README.md
29
+ - Rakefile
30
+ - bin/console
31
+ - bin/setup
32
+ - config/default.yml
33
+ - csvcop.gemspec
34
+ - exe/csvcop
35
+ - lib/csvcop.rb
36
+ - lib/csvcop/cli.rb
37
+ - lib/csvcop/config.rb
38
+ - lib/csvcop/config_loader.rb
39
+ - lib/csvcop/cop.rb
40
+ - lib/csvcop/cop/uniq_column.rb
41
+ - lib/csvcop/error.rb
42
+ - lib/csvcop/version.rb
43
+ homepage: https://jolantern.mugcup.xyz
44
+ licenses:
45
+ - MIT
46
+ metadata:
47
+ allowed_push_host: https://rubygems.org
48
+ homepage_uri: https://jolantern.mugcup.xyz
49
+ source_code_uri: https://github.com/j-o-lantern0422/csvcop
50
+ changelog_uri: https://github.com/j-o-lantern0422/csvcop
51
+ post_install_message:
52
+ rdoc_options: []
53
+ require_paths:
54
+ - lib
55
+ required_ruby_version: !ruby/object:Gem::Requirement
56
+ requirements:
57
+ - - ">="
58
+ - !ruby/object:Gem::Version
59
+ version: 2.3.0
60
+ required_rubygems_version: !ruby/object:Gem::Requirement
61
+ requirements:
62
+ - - ">="
63
+ - !ruby/object:Gem::Version
64
+ version: '0'
65
+ requirements: []
66
+ rubygems_version: 3.1.3
67
+ signing_key:
68
+ specification_version: 4
69
+ summary: csv linter like rubocop
70
+ test_files: []