tiered_category_expressions 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15ca9e46201d4f51bcc1734b3fbca4486118dc67
-  data.tar.gz: 897342e4cdd92b79264757cbd6a164fb390f3617
+  metadata.gz: 95d291c697c6b9f3d29be20655ea73a16f2ee6a0
+  data.tar.gz: 875f86055b23b5348e5b008e09bd082c415a3479
 SHA512:
-  metadata.gz: 20d53471af2037ffbbea9df52d5fc62541347af70578cf9ea477d4de5605fac4cb7990fb8913dd43f9225e3a218a41e761356e786d4607583777faa206237513
-  data.tar.gz: 602f8bc18e5e32fa16dabce62c9af90257d8492075fea94e3d89d51e610f578c1e8d82419f6375a53314b49f74eae1a96aefc7f164787ecbacb01681bbb14141
+  metadata.gz: c025a3500d381b809e680cfdf9d32b88590c91762c7fb84a180da719db253eb6a5fa50ba9005408a04804f0bf13901531264aacaea14c95baf9833ad5b74419f
+  data.tar.gz: 7b5c11c76b49b96a7175177309060f3fb6a362a570083e4feea14ec556a0d65b20dba609404d4aa84ce6c8adcd32aa2e572ec0c94132ee83868b54c2259d164f

data/.yardopts

@@ -2,7 +2,9 @@
 --hide-tag internal
 lib/tiered_category_expressions.rb
 lib/tiered_category_expressions/expression.rb
+lib/tiered_category_expressions/generator.rb
 lib/tiered_category_expressions/preprocessor.rb
+lib/tiered_category_expressions/exceptions.rb
 -
 LANGREF.md
 LICENSE.txt

data/README.md

@@ -32,8 +32,8 @@ require 'tiered_category_expressions/core'
 
 ## Documentation
 
-  - [Library documentation](https://rubydocs.info/tiered_category_expressions)
-  - [TCE language reference](https://rubydocs.info/tiered_category_expressions/file.LANGREF.html)
+  - [Library documentation](https://www.rubydoc.info/gems/tiered_category_expressions/)
+  - [TCE language reference](https://www.rubydoc.info/gems/tiered_category_expressions/file/LANGREF.md)
 
 ## Usage examples
 

data/lib/tiered_category_expressions/core.rb

@@ -1,3 +1,5 @@
+require "tiered_category_expressions/preprocessor"
+require "tiered_category_expressions/generator"
 require "tiered_category_expressions/expression"
 
 module TieredCategoryExpressions

data/lib/tiered_category_expressions/exceptions.rb

@@ -0,0 +1,4 @@
+module TieredCategoryExpressions
+  class Error < StandardError; end
+  class ParseError < Error; end
+end

data/lib/tiered_category_expressions/expression.rb

@@ -1,11 +1,11 @@
 require "tiered_category_expressions/parser"
 require "tiered_category_expressions/transformer"
 require "tiered_category_expressions/preprocessor"
+require "tiered_category_expressions/generator"
 require "tiered_category_expressions/util"
+require "tiered_category_expressions/exceptions"
 
 module TieredCategoryExpressions
-  class ParseError < StandardError; end
-
   class << self
     # Converts input to an {Expression}.
     #
@@ -28,8 +28,8 @@ module TieredCategoryExpressions
     # @raise [ParseError] Raises if TCE syntax is invalid
     #
     def self.parse(str)
-      tree = TieredCategoryExpressions::Parser.new.parse(str)
-      TieredCategoryExpressions::Transformer.new.apply(tree)
+      tree = Parser.new.parse(str)
+      Transformer.new.apply(tree)
     rescue Parslet::ParseFailed => e
       deepest = Util.deepest_parse_failure_cause(e.parse_failure_cause)
       _, column = deepest.source.line_and_column(deepest.pos)
@@ -76,7 +76,7 @@ module TieredCategoryExpressions
     # @return [Boolean]
     #
     def ==(other)
-      to_regexp == TCE(other).to_regexp
+      to_regexp == TieredCategoryExpressions::TCE(other).to_regexp
     end
 
     # Concatenates two expressions.
@@ -89,7 +89,7 @@ module TieredCategoryExpressions
     # @return [Expression]
     #
     def >(other)
-      self.class.new(@tiers + TCE(other).tiers)
+      self.class.new(@tiers + TieredCategoryExpressions::TCE(other).tiers)
     end
 
     # Returns an SQL LIKE query that may be used to speed up certain SQL queries.

data/lib/tiered_category_expressions/generator.rb

@@ -0,0 +1,35 @@
+require "tiered_category_expressions/exceptions"
+require "tiered_category_expressions/expression"
+
+module TieredCategoryExpressions
+  module Generator
+    class << self
+      # Generates a basic TCE that matches the given category. Returns nil if no valid TCE can be generated.
+      #
+      # @example
+      #  TieredCategoryExpressions::Generator.call(["Non-food", "Baby", "Baby formula"])
+      #  # => TieredCategoryExpressions::Expression[Nonfood > Baby > Baby formula]
+      #
+      # @param category [Array<String>]
+      # @return [Expression, nil]
+      #
+      def call(category)
+        tiers = category.map { |t| sanitize_name(t) or return nil }
+
+        TieredCategoryExpressions::TCE(tiers.join(" > "))
+      end
+
+      private
+
+      def sanitize_name(str)
+        str = str.gsub(/[^[:alnum:]\s]/, "") # remove non-word characters
+                 .gsub(/\s+/, " ")           # squish whitespace
+                 .strip
+
+        return if str == ""
+
+        str
+      end
+    end
+  end
+end

data/lib/tiered_category_expressions/preprocessor.rb

@@ -1,3 +1,5 @@
+require "tiered_category_expressions/util"
+
 module TieredCategoryExpressions
   # @internal TODO Deal with digits and dashes ("1-3 months" != "13months")
   module Preprocessor
@@ -23,7 +25,7 @@ module TieredCategoryExpressions
 
       def sanitize_name(str)
         str = Util.transliterate(str)
-        str.downcase.gsub(/[^a-z0-9]/, "") # remove all non word & non space characters
+        str.downcase.gsub(/[^a-z0-9]/, "") # remove all non-word & space characters
       end
     end
   end

data/lib/tiered_category_expressions/version.rb

@@ -1,3 +1,3 @@
 module TieredCategoryExpressions
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiered_category_expressions
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sjoerd Andringa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-04 00:00:00.000000000 Z
+date: 2019-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -129,7 +129,9 @@ files:
 - bin/setup
 - lib/tiered_category_expressions.rb
 - lib/tiered_category_expressions/core.rb
+- lib/tiered_category_expressions/exceptions.rb
 - lib/tiered_category_expressions/expression.rb
+- lib/tiered_category_expressions/generator.rb
 - lib/tiered_category_expressions/name.rb
 - lib/tiered_category_expressions/namelist.rb
 - lib/tiered_category_expressions/parser.rb