query_builder 0.0.1

data/config/metrics/cane.yml

@@ -0,0 +1,5 @@
+---
+abc_max: "10"
+line_length: "80"
+no_doc: "y"
+no_readme: "y"

data/config/metrics/churn.yml

@@ -0,0 +1,6 @@
+---
+ignore_files:
+- spec
+- config
+minimum_churn_count: 0
+start_date: "1 year ago"

data/config/metrics/flay.yml

@@ -0,0 +1,2 @@
+---
+minimum_score: 8

data/config/metrics/metric_fu.yml

@@ -0,0 +1,14 @@
+---
+folders: # The list of folders to be used by any metric.
+- lib
+metrics: # The list of allowed metrics. The other metrics are disabled.
+- cane
+- churn
+- flay
+- flog
+- reek
+- roodi
+- saikuro
+format: html
+output: tmp/metric_fu
+verbose: false

data/config/metrics/reek.yml

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

data/config/metrics/roodi.yml

@@ -0,0 +1,24 @@
+---
+AssignmentInConditionalCheck:
+CaseMissingElseCheck:
+ClassLineCountCheck:
+  line_count: 100
+ClassNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ClassVariableCheck:
+CyclomaticComplexityBlockCheck:
+  complexity: 3
+CyclomaticComplexityMethodCheck:
+  complexity: 5
+EmptyRescueBodyCheck:
+ForLoopCheck:
+MethodLineCountCheck:
+  line_count: 6
+MethodNameCheck:
+  pattern: !ruby/regexp /^[\||\^|\&|\!]$|^[_a-z<>=\[|+-\/\*`]+[_a-z0-9_<>=~@\[\]]*[=!\?]?$/
+ModuleLineCountCheck:
+  line_count: 200
+ModuleNameCheck:
+  pattern: !ruby/regexp /^[A-Z][a-zA-Z0-9]*$/
+ParameterNumberCheck:
+  parameter_count: 4

data/config/metrics/rubocop.yml

@@ -0,0 +1,80 @@
+---
+# settings added by the 'hexx-suit' module
+# output: "tmp/rubocop"
+# format: "html"
+
+AllCops:
+  Exclude:
+    - '**/db/schema.rb'
+
+Lint/HandleExceptions:
+  Exclude:
+    - '**/*_spec.rb'
+
+Lint/RescueException:
+  Exclude:
+    - '**/*_spec.rb'
+
+Metrics/ModuleLength:
+  Exclude:
+    - '**/*_spec.rb' # allow namespaces in specs
+
+Style/AccessorMethodName:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Enabled: false
+
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+Style/EmptyLinesAroundMethodBody:
+  Enabled: false
+
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+Style/EmptyLineBetweenDefs:
+  Enabled: false
+
+Style/FileName:
+  Enabled: false
+
+Style/LineLength:
+  Exclude:
+    - '**/*_spec.rb' # allow long CQL statements
+
+Style/RaiseArgs:
+  EnforcedStyle: compact
+
+Style/SingleLineMethods:
+  Exclude:
+    - '**/*_spec.rb'
+
+Style/SingleSpaceBeforeFirstArg:
+  Enabled: false
+
+Style/SpecialGlobalVars:
+  Exclude:
+    - '**/Gemfile'
+    - '**/*.gemspec'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrivialAccessors:
+  Exclude:
+    - '**/*_spec.rb'

data/config/metrics/saikuro.yml

@@ -0,0 +1,3 @@
+---
+warn_cyclo:  3
+error_cyclo: 4

data/config/metrics/simplecov.yml

@@ -0,0 +1,6 @@
+---
+output: tmp/coverage
+filters: # The list of paths to be excluded from coverage checkup
+- "spec/"
+- "config/"
+groups: []

data/config/metrics/yardstick.yml

@@ -0,0 +1,37 @@
+---
+# Settings added by the 'hexx-suit' gem
+output: "tmp/yardstick/output.log"
+path: "lib/**/*.rb"
+rules:
+  ApiTag::Presence:
+    enabled: true
+    exclude: []
+  ApiTag::Inclusion:
+    enabled: true
+    exclude: []
+  ApiTag::ProtectedMethod:
+    enabled: true
+    exclude: []
+  ApiTag::PrivateMethod:
+    enabled: false
+    exclude: []
+  ExampleTag:
+    enabled: true
+    exclude: []
+  ReturnTag:
+    enabled: true
+    exclude: []
+  Summary::Presence:
+    enabled: true
+    exclude: []
+  Summary::Length:
+    enabled: true
+    exclude: []
+  Summary::Delimiter:
+    enabled: true
+    exclude: []
+  Summary::SingleLine:
+    enabled: true
+    exclude: []
+threshold: 100
+verbose: false

data/lib/query_builder.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require "equalizer"
+require "ice_nine"
+require "transproc"
+
+require_relative "query_builder/version"
+require_relative "query_builder/core"
+require_relative "query_builder/cql"

data/lib/query_builder/core.rb

@@ -0,0 +1,19 @@
+# encoding: utf-8
+
+# The builder of CQL (Cassandra Query Language) statements
+#
+module QueryBuilder
+
+  # The collection of core classes and modules to provide SQL-specific AST
+  #
+  module Core
+
+    require_relative "core/attribute_error"
+    require_relative "core/attribute"
+    require_relative "core/base"
+    require_relative "core/clause"
+    require_relative "core/statement"
+
+  end # module Core
+
+end # module QueryBuilder

data/lib/query_builder/core/attribute.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module QueryBuilder::Core
+
+  # Describes the attribute of AST node
+  #
+  class Attribute
+
+    include Equalizer.new(:name)
+
+    # @!attribute [r] name
+    #
+    # @return [Symbol] The name of the attribute
+    #
+    attr_reader :name
+
+    # @!attribute [r] default
+    #
+    # @return [Object] The default value for the attribute
+    #
+    attr_reader :default
+
+    # @!attribute [r] required
+    #
+    # @return [Boolean] Whether the attribute is required or not
+    #
+    attr_reader :required
+
+    # Initializes the attribute with name and options
+    #
+    # @param [Symbol] name
+    # @param [Hash] options
+    # @option options [Object] :default The default value for the attribute
+    # @option options [Boolean] :required Whether the attribute is required
+    #
+    def initialize(name, options = {})
+      @name     = name
+      @default  = options[:default]
+      @required = options.fetch(:required) { false }
+
+      IceNine.deep_freeze(self)
+    end
+
+    # Returns arguments of the attribute initializer
+    #
+    # @return [Array]
+    #
+    def arguments
+      [name, default: default, required: required]
+    end
+
+  end # class Attribute
+
+end # module QueryBuilder::Core

data/lib/query_builder/core/attribute_error.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module QueryBuilder::Core
+
+  # The exception to be raised by AST nodes' initializers
+  #
+  class AttributeError < KeyError
+
+    # Initializes the error with problem definition and the list of attributes
+    #
+    # @param [#to_s] problem
+    # @param [Array<#to_s>] list
+    #
+    def initialize(problem, list)
+      super [
+        "#{problem} attribute",
+        (list.one? ? ": " : "s: "),
+        list.map { |item| ":#{item}" }.join(", ")
+      ].join
+      IceNine.deep_freeze(self)
+    end
+
+  end # class UndefinedAttributeError
+
+end # module QueryBuilder::Core

data/lib/query_builder/core/base.rb

@@ -0,0 +1,102 @@
+# encoding: utf-8
+
+module QueryBuilder::Core
+
+  # The abstract base class for all nodes of AST: statemens, clauses, operators
+  #
+  # Declares common attributes, `#initializer`, and `#to_s` instance methods.
+  #
+  # @abstract
+  #
+  class Base
+
+    # @!method attributes
+    # The hash of default attributes of class' instances
+    #
+    # @return [Hash]
+    #
+    def self.attributes
+      @attributes ||= Set.new
+    end
+
+    # @!method attribute(name, options)
+    # Declares the attribute with optional default value
+    #
+    # @param [Symbol] name The name of the attribute
+    # @param [Hash] options
+    # @option options [Object] :default
+    #
+    # @return [undefined]
+    #
+    def self.attribute(name, options = {})
+      attributes << Attribute.new(name, options)
+      define_method(name) { attributes.fetch(name) }
+    end
+
+    # Makes default attributes inheritable
+    #
+    # @private
+    #
+    def self.inherited(subclass)
+      attributes.each do |item|
+        subclass.public_send(:attribute, *item.arguments)
+      end
+    end
+
+    # @!attribute [r] attributes
+    #
+    # @return [Hash] The hash of the initialized attributes
+    #
+    attr_reader :attributes
+
+    # @!method initialize(attributes = {})
+    # Initializes the instance
+    #
+    # @param [Hash] attributes The custom attributes of the instance
+    #
+    def initialize(attributes = {})
+      validate_unknown attributes
+      validate_missing attributes
+
+      @attributes = default_attributes.merge(attributes)
+      IceNine.deep_freeze(self)
+    end
+
+    # @!method to_s
+    # Returns the current chunk of CQL statement
+    #
+    # @return [String]
+    #
+    # @abstract
+    #
+    def to_s
+      ""
+    end
+
+    private
+
+    def known_attributes
+      self.class.attributes
+    end
+
+    def required_attributes
+      known_attributes.select(&:required)
+    end
+
+    def default_attributes
+      known_attributes.each_with_object({}) { |e, a| a[e.name] = e.default }
+    end
+
+    def validate_unknown(hash)
+      unknown = hash.keys - known_attributes.map(&:name)
+      fail AttributeError.new(:unknown, unknown) if unknown.any?
+    end
+
+    def validate_missing(hash)
+      missed = required_attributes.map(&:name) - hash.keys
+      fail AttributeError.new(:missed, missed) if missed.any?
+    end
+
+  end # class Base
+
+end # module CQLBuiler::Core

data/lib/query_builder/core/clause.rb

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+module QueryBuilder::Core
+
+  # The base class for all AST clauses (parts of statement)
+  #
+  # Every clause has a type, allowing to filter clauses of a statement.
+  #
+  # @abstract
+  #
+  class Clause < Base
+
+    include Comparable
+    include Equalizer.new(:class, :attributes)
+
+    # Makes all instances of the class unique
+    #
+    # Only one instance can be added to the statement via `Statement#<<` method
+    #
+    # @return [undefined]
+    #
+    def self.unique
+      include Equalizer.new(:class)
+    end
+
+    # Gets/sets type for the specific clause class
+    #
+    # @param [#to_sym, nil] value
+    #
+    # @return [Symbol, nil]
+    #
+    def self.type(value = nil)
+      value ? (@type = value) : @type
+    end
+
+    # @!method type
+    #
+    # @return [Symbol] The type of the clause
+    #
+    def type
+      self.class.type
+    end
+
+  end # class Clause
+
+end # module QueryBuilder::Core