openactive 0.1.0.rc1

data/lib/openactive/validators/date_time_validator.rb

@@ -0,0 +1,40 @@
+module OpenActive
+  module Validators
+    class DateTimeValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      def coerce(value)
+        return value if value.is_a?(::DateTime)
+
+        # if it's a date/time object other than datetime, convert it (Date/Time)
+        return value.to_datetime if value.respond_to?(:to_datetime)
+
+        parse_date(value)
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        return true if value.is_a?(::DateTime) || value.respond_to?(:to_datetime)
+
+        return false unless value.is_a?(String)
+
+        !parse_date(value).nil?
+      end
+
+      private
+
+      def parse_date(value)
+        DateTime.parse(value)
+      rescue ArgumentError => _e
+        nil
+      end
+    end
+  end
+end

data/lib/openactive/validators/enum_validator.rb

@@ -0,0 +1,33 @@
+module OpenActive
+  module Validators
+    class EnumValidator < BaseValidator
+      def initialize(classname)
+        @classname = classname
+      end
+
+      # Coerce enum url to the enum instance
+      #
+      # @param value [mixed] Unum instance or URL
+      # @return [int] The coerced enum
+      def coerce(value)
+        return value if value.is_a?(classname)
+
+        classname.find_by_value(value)
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        return true if value.is_a?(classname)
+
+        classname.find_by_value(value)
+      end
+
+      private
+
+      attr_accessor :classname
+    end
+  end
+end

data/lib/openactive/validators/float_validator.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Validators
+    class FloatValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [float] The coerced value
+      def coerce(value)
+        value.to_f
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        Float(value)
+        true
+      rescue ArgumentError => _e
+        false
+      end
+    end
+  end
+end

data/lib/openactive/validators/instance_validator.rb

@@ -0,0 +1,19 @@
+module OpenActive
+  module Validators
+    class InstanceValidator < BaseValidator
+      attr_accessor :classname
+
+      def initialize(classname)
+        @classname = classname
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        value.is_a?(classname)
+      end
+    end
+  end
+end

data/lib/openactive/validators/int_validator.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Validators
+    class IntValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [int] The coerced value
+      def coerce(value)
+        value.to_i
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        Integer(value)
+        true
+      rescue ArgumentError => _e
+        false
+      end
+    end
+  end
+end

data/lib/openactive/validators/null_validator.rb

@@ -0,0 +1,13 @@
+module OpenActive
+  module Validators
+    class NullValidator < BaseValidator
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        value.nil?
+      end
+    end
+  end
+end

data/lib/openactive/validators/number_validator.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Validators
+    class NumberValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [float] The coerced value
+      def coerce(value)
+        BigDecimal(value.to_s)
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        BigDecimal(value.to_s)
+        true
+      rescue ArgumentError => _e
+        false
+      end
+    end
+  end
+end

data/lib/openactive/validators/string_validator.rb

@@ -0,0 +1,26 @@
+module OpenActive
+  module Validators
+    class StringValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      def coerce(value)
+        value.to_str
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        return true if value.is_a?(String)
+        return true if value.respond_to?(:to_str)
+
+        false
+      end
+    end
+  end
+end

data/lib/openactive/validators/time_validator.rb

@@ -0,0 +1,29 @@
+module OpenActive
+  module Validators
+    # https://schema.org/Time
+    # format spec: https://www.w3.org/TR/xmlschema-2/#time
+    class TimeValidator < BaseValidator
+      # https://www.oreilly.com/library/view/regular-expressions-cookbook/9781449327453/ch04s07.html#id2175516
+      # Minor additions to make second values and timezone optional
+      REGEX = /(?<hour>2[0-3]|[01][0-9]):?(?<minute>[0-5][0-9]):?(?<second>[0-5][0-9])?(?<timezone>Z|[+-](?:2[0-3]|[01][0-9])(?::?(?:[0-5][0-9]))?)?/
+
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      def coerce(value)
+        value
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        REGEX =~ value
+      end
+    end
+  end
+end

data/lib/openactive/validators/uri_validator.rb

@@ -0,0 +1,27 @@
+module OpenActive
+  module Validators
+    class UriValidator < BaseValidator
+      # Coerce given value to the type the validator is validating against.
+      # PLEASE NOTE: no checks are performed on the given value.
+      # It is therefore recommended to call the "run" method first before this.
+      #
+      # @param value [mixed] The value to coerce.
+      # @return [mixed] The same value.
+      def coerce(value)
+        return value if value.is_a?(::URI)
+
+        URI.parse(value)
+      end
+
+      # Run validation on the given value.
+      #
+      # @param value [mixed] The value to validate.
+      # @return [Boolean] Whether validation passes or not.
+      def run(value)
+        return true if value.is_a?(::URI)
+
+        value =~ ::URI::DEFAULT_PARSER.make_regexp
+      end
+    end
+  end
+end

data/lib/openactive/version.rb

@@ -0,0 +1,3 @@
+module OpenActive
+  VERSION = "0.1.0.rc1".freeze
+end

data/lib/openactive.rb

@@ -0,0 +1,52 @@
+require 'json'
+require 'active_support/duration'
+require 'active_support/core_ext/date_time'
+require 'typesafe_enum'
+module OpenActive
+  require "openactive/version"
+
+  require "openactive/concerns/type_checker"
+  require "openactive/concerns/json_ld_serializable"
+
+  require "openactive/exceptions/invalid_argument_exception"
+
+  require "openactive/helpers/json_ld"
+
+  require "openactive/validators/base_validator"
+  require "openactive/validators/array_of_validator"
+  require "openactive/validators/array_validator"
+  require "openactive/validators/base_model_validator"
+  require "openactive/validators/bool_validator"
+  require "openactive/validators/date_interval_validator"
+  require "openactive/validators/date_time_validator"
+  require "openactive/validators/enum_validator"
+  require "openactive/validators/float_validator"
+  require "openactive/validators/instance_validator"
+  require "openactive/validators/int_validator"
+  require "openactive/validators/null_validator"
+  require "openactive/validators/number_validator"
+  require "openactive/validators/string_validator"
+  require "openactive/validators/time_validator"
+  require "openactive/validators/uri_validator"
+
+  require "openactive/base_model"
+  require "openactive/json_ld_model"
+
+  require "openactive/rpde/rpde_body"
+  require "openactive/rpde/rpde_kind"
+  require "openactive/rpde/rpde_state"
+  require "openactive/rpde/rpde_item"
+
+  require "openactive/rpde/exceptions/rpde_exception"
+  require "openactive/rpde/exceptions/deleted_items_data_exception"
+  require "openactive/rpde/exceptions/first_time_after_change_number_exception"
+  require "openactive/rpde/exceptions/first_time_after_timestamp_and_after_id_exception"
+  require "openactive/rpde/exceptions/incomplete_items_data_exception"
+  require "openactive/rpde/exceptions/modified_id_items_order_exception"
+  require "openactive/rpde/exceptions/next_change_numbers_items_order_exception"
+
+  generated_files = JSON.parse(File.read(File.join(__dir__, 'openactive', 'files_index.json')))
+  generated_files.each do |file|
+    require File.join(__dir__, 'openactive', file)
+  end
+end

data/openactive.gemspec

@@ -0,0 +1,35 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "openactive/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "openactive"
+  spec.version       = OpenActive::VERSION
+  spec.authors       = ["OpenActive Community"]
+  spec.email         = ["hello@openactive.io"]
+
+  spec.summary       = 'OpenActive.io objects turned into strongly typed classes for use in Ruby.'
+  spec.description   = 'OpenActive.io objects turned into strongly typed classes for use in Ruby. All classes can be serialized into JSON/JSON-LD, to provide easy conformance with the OpenActive Modelling Specification.'
+  spec.homepage      = "https://github.com/openactive/models-ruby/"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-json_expectations"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rspec"
+  spec.add_development_dependency "yard"
+
+  spec.add_runtime_dependency "activesupport"
+  spec.add_runtime_dependency "typesafe_enum"
+end

data/yard_extensions/define_property_handler.rb

@@ -0,0 +1,68 @@
+# Heavily based on YARD::Handlers::Ruby::AttributeHandler
+class DefinePropertyHandler < YARD::Handlers::Ruby::Base
+  handles method_call(:define_property)
+  namespace_only
+
+  process do
+    return if statement.type == :var_ref || statement.type == :vcall
+
+    read = true
+    write = true
+    params = statement.parameters(false).dup
+
+    # Add all attributes
+    name = validated_attribute_names(params)
+
+    namespace.attributes[scope][name] ||= SymbolHash[read: nil, write: nil]
+
+    # Show their methods as well
+    {read: name, write: "#{name}="}.each do |type, meth|
+      if type == :read ? read : write
+        o = MethodObject.new(namespace, meth, scope)
+        if type == :write
+          o.parameters = [['value', nil]]
+          src = "def #{meth}(value)"
+          full_src = "#{src}\n  @#{name} = value\nend"
+          doc = "Sets the attribute #{name}\n@param value the value to set the attribute #{name} to."
+        else
+          src = "def #{meth}"
+          full_src = "#{src}\n  @#{name}\nend"
+          doc = "Returns the value of attribute #{name}"
+        end
+        o.source ||= full_src
+        o.signature ||= src
+        register(o)
+        o.docstring = doc if o.docstring.blank?(false)
+
+        # Register the object explicitly
+        namespace.attributes[scope][name][type] = o
+      else
+        obj = namespace.children.find { |other| other.name == meth.to_sym && other.scope == scope }
+
+        # register an existing method as attribute
+        namespace.attributes[scope][name][type] = obj if obj
+      end
+    end
+  end
+
+  protected
+
+  # Strips out any non-essential arguments from the attr statement.
+  #
+  # @param [Array<Parser::Ruby::AstNode>] params a list of the parameters
+  #   in the attr call.
+  # @return [Array<String>] the validated attribute names
+  # @raise [Parser::UndocumentableError] if the arguments are not valid.
+  def validated_attribute_names(params)
+    obj = params.first
+
+    case obj.type
+    when :symbol_literal
+      obj.jump(:ident, :op, :kw, :const).source
+    when :string_literal
+      obj.jump(:string_content).source
+    else
+      raise YARD::Parser::UndocumentableError, obj.source
+    end
+  end
+end

data/yard_extensions.rb

@@ -0,0 +1,4 @@
+# Load all Ruby files inside of the YARD extensions directory.
+Dir.glob('yard_extensions/**.rb') do |file|
+  require_relative file
+end