querly 0.3.0.beta.1 → 0.3.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 278d6249e0070a8df23463f5a87e192723582d9b
-  data.tar.gz: 7f25f0bec22cc8fa8dc715aaa1c151f917ddbe1a
+  metadata.gz: 4f3f39b82c237a02443b2af98cf6cf6fc756efaf
+  data.tar.gz: c22eab0318c79b835b5f58d000c9665dc807db8a
 SHA512:
-  metadata.gz: 3fce9e93f1b3656ab76379d105eb5812694ebd21d812d3db673bc7d62c8ca8b1ddb57adc4500cf111c9c9bd29aafd37d7cb48b827806fb4cb130bd0ca8470893
-  data.tar.gz: 406d47ca60ac29da0d1adae7c239e327fa71640bc713fc4cbc2fd2ef1488ba6a0154cc3619ab7c45ac1aa2b67cc75cc786efdfcd38cb056c999e73f3f44c3e2d
+  metadata.gz: 65e67f8456628399a50129d351920fdf122bcda0c5550516e883e5300f4152cef6b223dc3a91fdbe83b02c8c3fe245eb685efd0c47e76571e99b1f269c8f1dce
+  data.tar.gz: 01a4612dac5af8cd3de0c6ae7322c11f51d716fd3d68af287f497ec32e2b244a053bb47bf80801e2a44f25102387c04a181dde8a14b88e913ae4409d04106173

data/CHANGELOG.md

@@ -4,6 +4,7 @@
 
 ## 0.3.0
 
+* Allow `require` rules from config file
 * Add `version` command
 * Fix *with block* and *without block* pattern parsing
 * Prettier backtrace printing

data/README.md

@@ -94,6 +94,27 @@ Visit our wiki pages for configuration and query language reference.
 
 Use `querly console` command to test patterns interactively.
 
+## Requiring Rules
+
+`import` section in config file now allows accepts `require` command.
+
+```yaml
+import:
+  - require: querly/rules/sample
+  - require: your_library/querly/rules
+```
+
+Querly ships with `querly/rules/sample` rule set. Check `lib/querly/rules/sample.rb` and `rules/sample.yml` for detail.
+
+### Publishing Gems with Querly Rules
+
+Querly provides `Querly.load_rule` API to allow publishing your rules as part of Ruby library.
+Put rules YAML file in your gem, and add Ruby script in some directory like `lib/your_library/querly/rules.rb`.
+
+```
+Querly.load_rules File.join(__dir__, relative_path_to_yaml_file)
+```
+
 ## Notes
 
 ### Querly's analysis is syntactic

data/lib/querly/config.rb

@@ -77,8 +77,15 @@ module Querly
               end
             end
           end
+
+          if import["require"]
+            stderr.puts "Require rules from #{import["require"]}..."
+            require import["require"]
+          end
         end
 
+        rules.concat Querly.required_rules
+
         checks = Array(yaml["check"]).map {|hash| Check.load(hash) }
 
         Config.new(rules: rules, preprocessors: preprocessors, checks: checks, root_dir: root_dir)

data/lib/querly/rules/sample.rb

@@ -0,0 +1 @@
+Querly.load_rule File.join(__dir__, "../../../rules/sample.yml")

data/lib/querly/version.rb

@@ -1,3 +1,3 @@
 module Querly
-  VERSION = "0.3.0.beta.1"
+  VERSION = "0.3.0.beta.2"
 end

data/lib/querly.rb

@@ -23,5 +23,18 @@ require "querly/check"
 require "querly/concerns/backtrace_formatter"
 
 module Querly
-  # Your code goes here...
+  @@required_rules = []
+
+  def self.required_rules
+    @@required_rules
+  end
+
+  def self.load_rule(*files)
+    files.each do |file|
+      path = Pathname(file)
+      yaml = YAML.load(path.read)
+      rules = yaml.map {|hash| Rule.load(hash) }
+      required_rules.concat rules
+    end
+  end
 end

data/rules/sample.yml

@@ -0,0 +1,34 @@
+- id: sample.ruby.pathname
+  pattern: Pathname.new
+  message: |
+    Did you mean `Pathname` method?
+
+- id: sample.ruby.file.dir
+  pattern: "File.dirname(:string:)"
+  message: |
+    Did you mean `__dir__`?
+
+- id: sample.ruby.file.open
+  pattern: File.open(...) !{}
+  message: |
+    Using block is better in Ruby
+
+- id: sample.ruby.debug_print
+  pattern:
+    - self.p
+    - self.pp
+  message: |
+    Delete debug print
+
+- id: sample.ruby.clone
+  pattern:
+    - clone()
+    - "clone(!freeze: _)"
+  message: |
+    Did you mean `dup`?
+
+    `clone` returns frozen object when receiver is frozen.
+
+    * If object is frozen, you usually does not need to clone it
+    * When you need a copy of a object, you provablly want to modify that; did you mean dup?
+    * Ruby 2.4 accepts freeze keyword and returns not frozen object

data/sample.yaml

@@ -130,7 +130,8 @@ preprocessor:
   .slim: slimrb --compile
 
 import:
-  - load: rules/*.yml
+  - load: querly/rules/*.yml
+  - require: querly/rules/sample
 
 check:
   - path: /

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: querly
 version: !ruby/object:Gem::Version
-  version: 0.3.0.beta.1
+  version: 0.3.0.beta.2
 platform: ruby
 authors:
 - Soutaro Matsumoto
@@ -162,10 +162,12 @@ files:
 - lib/querly/pp/cli.rb
 - lib/querly/preprocessor.rb
 - lib/querly/rule.rb
+- lib/querly/rules/sample.rb
 - lib/querly/script.rb
 - lib/querly/script_enumerator.rb
 - lib/querly/version.rb
 - querly.gemspec
+- rules/sample.yml
 - sample.yaml
 homepage: https://github.com/soutaro/querly
 licenses: []