coconductor 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 295cf8fe4384c753c323d0617abf9b74436ad0887ae3558b4684b90819aabad1
-  data.tar.gz: cb50009fe71804e04ab800c3ab9e1d1e3d7490002d06d1e4f9d36121c67eab52
+  metadata.gz: 05bb04085f2577f27816fad8a5c2fe21772401516f3e245d238aa8bf97437f31
+  data.tar.gz: 5cd56a968556c68e4c527ca53cced7a20e2869d3cfd5d70dd02d7d37b432d543
 SHA512:
-  metadata.gz: dfa120239578da0cc879d7029c54e3c2420270d3e07482113cba126bf8acaaa16d7d6222af94f00da03b0e685a27b2376c086d721db2fba821e7210d17ac9ab3
-  data.tar.gz: '081cc970eb3bfa46838849cc5e504d3af04dc2b8d007c8b8d4114993011fd862859392121ad3d25373c8cf84d8a41f838e5261799742752e2e2974cfcd17ffa9'
+  metadata.gz: 3815b1990aca73057b3442225327a6002772bbc8b5e02f2fab024346166c92de713b64befd5bacdf3e215048cb9407df1ebdf748c8efaeb3f1cfefd250084c9b
+  data.tar.gz: c2714f37217cd29b5b2e0efb794c06fe4d5e86bd2ed4f4b64f0af16124688c5a7870fa950f08bd06b0f203d4f159c7aeaf63e89a58028ff6cedf65eb74a0f53c

data/lib/coconductor/code_of_conduct.rb

@@ -64,7 +64,6 @@ module Coconductor
       /(?<major>\d)/(?<minor>\d)(/(?<patch>\d))?
       /#{Coconductor::ProjectFiles::CodeOfConductFile::FILENAME_REGEX}
     }ix
-    FIELD_REGEX = /\[(?<name>[A-Z_ ]{2,}).*\]/
 
     attr_reader :key
     attr_writer :content
@@ -125,7 +124,7 @@ module Coconductor
     end
 
     def fields
-      content.scan(FIELD_REGEX).flatten
+      @fields ||= Field.from_code_of_conduct(self)
     end
 
     private

data/lib/coconductor/field.rb

@@ -0,0 +1,78 @@
+module Coconductor
+  # Represents a fillable field in a code of conduct
+  class Field
+    REGEX = /\[(?<name>[A-Z_ ]{2,}):?\s?(?<description>.*)\]/
+
+    # the matchable raw text within the code of conduct including brackets
+    attr_reader :raw_text
+
+    class << self
+      # Returns an array of Fields for the given code of conduct
+      def from_code_of_conduct(code_of_conduct)
+        matches = []
+
+        code_of_conduct.content.scan(REGEX) do |_m|
+          matches << Regexp.last_match
+        end
+
+        fields = matches.map do |m|
+          new(m[0], name: m[:name], description: m[:description])
+        end
+
+        fields.uniq(&:key)
+      end
+
+      # Returns all fields accross all vendored codes of conduct
+      def all
+        @all ||= CodeOfConduct.latest.map(&:fields).flatten.uniq(&:key)
+      end
+    end
+
+    def initialize(raw_text, name: nil, description: nil)
+      @raw_text = raw_text
+      @name = name
+      @description = description
+    end
+
+    # The unformatted field name as found in the code of conduct text
+    def name
+      @name ||= parts ? parts[:name].strip : nil
+    end
+
+    # human readable label
+    def label
+      @label ||= normalized_name.downcase.tr('_', ' ').capitalize
+    end
+
+    # machine readable key
+    def key
+      @key ||= normalized_name.downcase
+    end
+
+    def description
+      @description ||= parts ? parts[:description] : nil
+    end
+
+    def inspect
+      methods = %w[name key label]
+      kvs = methods.map { |method| [method, public_send(method)] }.to_h
+      kvs = kvs.map { |k, v| "#{k}=\"#{v}\"" }.join(' ')
+      "<Coconductor::Field #{kvs}>"
+    end
+
+    private
+
+    def parts
+      @parts ||= raw_text.match(REGEX)
+    end
+
+    def normalized_name
+      @normalized_name ||= begin
+        normalized_name = name.tr(' ', '_')
+        normalized_name = normalized_name.gsub(/\A(YOUR|INSERT)_/i, '')
+        normalized_name = normalized_name.gsub(/_?HERE\z/i, '')
+        normalized_name.strip
+      end
+    end
+  end
+end

data/lib/coconductor/matchers/field_aware.rb

@@ -23,7 +23,7 @@ module Coconductor
         coc = code_of_conduct.dup
         coc.instance_variable_set '@content_normalized', nil
         coc.instance_variable_set '@content_without_title_and_version', nil
-        field_regex = /\[?#{Regexp.union(coc.fields)}\]?/
+        field_regex = /#{Regexp.union(coc.fields.map(&:raw_text))}/i
         coc.content = coc.content.gsub(field_regex, FIELD_PLACEHOLDER)
         regex = Regexp.escape(coc.content_normalized)
         regex = regex.gsub(FIELD_PLACEHOLDER_REGEX, '([a-z ]+?)')

data/lib/coconductor/version.rb

@@ -1,3 +1,3 @@
 module Coconductor
-  VERSION = '0.4.0'.freeze
+  VERSION = '0.5.0'.freeze
 end

data/lib/coconductor.rb

@@ -3,6 +3,7 @@ require 'licensee'
 
 module Coconductor
   autoload :CodeOfConduct, 'coconductor/code_of_conduct'
+  autoload :Field,         'coconductor/field'
   autoload :Matchers,      'coconductor/matchers'
   autoload :Projects,      'coconductor/projects'
   autoload :ProjectFiles,  'coconductor/project_files'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coconductor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Ben Balter
@@ -160,6 +160,7 @@ files:
 - lib/coconductor/commands/detect.rb
 - lib/coconductor/commands/diff.rb
 - lib/coconductor/commands/version.rb
+- lib/coconductor/field.rb
 - lib/coconductor/matchers.rb
 - lib/coconductor/matchers/dice.rb
 - lib/coconductor/matchers/exact.rb