onoma 0.3.1 → 0.5.0

data/lib/onoma.rb

@@ -1,32 +1,48 @@
-require 'onoma/version'
+require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
+require 'active_support/core_ext/array/access'
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'bigdecimal'
+require 'date'
+require 'i18n'
 require 'nokogiri'
-require 'active_support/hash_with_indifferent_access'
-
-require 'onoma/item'
-require 'onoma/migration'
-require 'onoma/nomenclature'
-require 'onoma/database'
-require 'onoma/property'
-require 'onoma/reference'
-require 'onoma/relation'
-require 'onoma/reflection'
 require 'pathname'
+require 'yaml'
+require 'zeitwerk'
+
+loader = Zeitwerk::Loader.for_gem
+loader.collapse("#{__dir__}/onoma/models")
+loader.setup
 
 module Onoma
   XMLNS = 'http://www.ekylibre.org/XML/2013/nomenclatures'.freeze
   NS_SEPARATOR = '-'.freeze
   PROPERTY_TYPES = %i[boolean item item_list choice choice_list string_list date decimal integer nomenclature string symbol].freeze
 
-  class MissingNomenclature < StandardError
+  class Error < ::StandardError
+  end
+
+  class MissingNomenclature < Error
+  end
+
+  class ItemNotFound < Error
+  end
+
+  class MissingChoices < Error
   end
 
-  class MissingChoices < StandardError
+  class InvalidPropertyNature < Error
   end
 
-  class InvalidProperty < StandardError
+  class InvalidProperty < Error
   end
 
   class << self
+    def escape_key(key)
+      key.to_s.gsub('.', '-').to_sym
+    end
+
     def root
       Pathname.new(__FILE__).dirname.dirname
     end
@@ -43,9 +59,36 @@ module Onoma
       database_path.join('reference.xml')
     end
 
-    def connection
-      load_database unless database_loaded?
-      @@set
+    # Returns version of DB
+    def reference_version
+      return 0 unless reference_path.exist?
+      reference_document.root['version'].to_i
+    end
+
+    def reference_document
+      unless @document
+        f = File.open(reference_path, 'rb')
+        @document = Nokogiri::XML(f) do |config|
+          config.strict.nonet.noblanks.noent
+        end
+        f.close
+      end
+      @document
+    end
+
+    # Returns list of Onoma::Migration
+    def migrations
+      Dir.glob(migrations_path.join('*.xml')).sort.collect do |f|
+        Onoma::Migration::Base.parse(Pathname.new(f))
+      end
+    end
+
+    # Returns list of migrations since last done
+    def missing_migrations
+      last_version = reference_version
+      migrations.select do |m|
+        m.number > last_version
+      end
     end
 
     # Returns the names of the nomenclatures
@@ -53,34 +96,49 @@ module Onoma
       set.nomenclature_names
     end
 
+    def all
+      set.nomenclatures
+    end
+
     # Give access to named nomenclatures
-    delegate :[], :nomenclatures, to: :set
-    alias all nomenclatures
+    # delegate :[], to: :set
+    def [](index)
+      set[index]
+    end
 
     # Give access to named nomenclatures
     def find(*args)
       args.extract_options!
       name = args.shift
+      nomenclature = find_or_initialize(name)
       if args.empty?
-        return set[name]
+        return nomenclature
       elsif args.size == 1
-        return set[name].find(args.shift) if set[name]
+        return nomenclature.find(args.shift) if nomenclature
       end
       nil
     end
 
+    def find_or_initialize(name)
+      set[name] || set.load_data_from_xml(name)
+    end
+
+    # Force loading of nomenclatures
+    def load!
+      @@set = NomenclatureSet.load_file(reference_path)
+    end
+
     # Browse all nomenclatures
     def each(&block)
       set.each(&block)
     end
 
     def set
-      @@set ||= Database.open(reference_path)
+      @@set ||= NomenclatureSet.new
     end
 
     def load_locales
-      I18n.load_path.concat(Dir.glob(root.join('config', 'locales', '**', '*.yml')))
+      I18n.load_path.concat(Dir.glob(Onoma.root.join('config', 'locales', '*.yml')))
     end
   end
 end
-

data/lib/onoma/item.rb

@@ -1,3 +1,5 @@
+require 'set'
+
 module Onoma
   # An item of a nomenclature is the core data.
   class Item
@@ -19,7 +21,7 @@ module Onoma
       else
         self.parent = parent
       end
-      @attributes = ActiveSupport::HashWithIndifferentAccess.new
+      @attributes = {}.with_indifferent_access
       @children = Set.new
       options.each do |k, v|
         set(k, v)
@@ -178,14 +180,28 @@ module Onoma
 
     # Return human name of item
     def human_name(options = {})
-      I18n.translate("nomenclatures.#{nomenclature.name}.items.#{name}", options.merge(default: ["items.#{name}".to_sym, "enumerize.#{nomenclature.name}.#{name}".to_sym, "labels.#{name}".to_sym, name.humanize]))
+      scope = options.delete(:scope)
+      no_attribute_translation = "nomenclatures.#{Onoma.escape_key(nomenclature.name)}.items.#{Onoma.escape_key(name)}"
+      if scope
+        scope_attribute = scope
+        other_attributes = attributes.except(scope_attribute)
+        scope_translation = "nomenclatures.#{Onoma.escape_key(nomenclature.name)}.items.#{Onoma.escape_key(scope_attribute)}.#{Onoma.escape_key(name)}"
+        other_translations = other_attributes.map { |attr_name, _value| "nomenclatures.#{Onoma.escape_key(nomenclature.name)}.items.#{Onoma.escape_key(attr_name)}.#{Onoma.escape_key(name)}" }
+        root = scope_translation
+        defaults = [no_attribute_translation, *other_translations]
+      else
+        scoped_by_attributes = attributes.map { |attr_name, _value| "nomenclatures.#{Onoma.escape_key(nomenclature.name)}.items.#{Onoma.escape_key(attr_name)}.#{Onoma.escape_key(name)}" }
+        root = "nomenclatures.#{Onoma.escape_key(nomenclature.name)}.items.#{Onoma.escape_key(name)}"
+        defaults = scoped_by_attributes
+      end
+      I18n.t(root, options.merge(default: [*defaults.map(&:to_sym), "items.#{Onoma.escape_key(name)}".to_sym, "enumerize.#{Onoma.escape_key(nomenclature.name)}.#{Onoma.escape_key(name)}".to_sym, "labels.#{Onoma.escape_key(name)}".to_sym, name.humanize]))
     end
     alias humanize human_name
     alias localize human_name
     alias l localize
 
     def human_notion_name(notion_name, options = {})
-      "nomenclatures.#{nomenclature.name}.notions.#{notion_name}.#{name}".t(options.merge(default: ["labels.#{name}".to_sym]))
+      I18n.t("nomenclatures.#{nomenclature.name}.notions.#{notion_name}.#{name}", options.merge(default: ["labels.#{name}".to_sym]))
     end
 
     def ==(other)

data/lib/onoma/migration/actions/base.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class Base
         def self.action_name
@@ -9,10 +9,6 @@ module Onoma
         def action_name
           self.class.action_name
         end
-
-        def label
-          action_name
-        end
       end
     end
   end

data/lib/onoma/migration/actions/item_change.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class ItemChange < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :name, :changes
@@ -22,10 +22,6 @@ module Onoma
           @changes[:name]
         end
 
-        def label
-          "change_item #{@nomenclature}##{@name}(" + changes.simple_print + ')'
-        end
-
         def human_name
           "Change item #{@nomenclature}##{@name} with " + changes.inspect
         end

data/lib/onoma/migration/actions/item_creation.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class ItemCreation < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :name, :options
@@ -20,10 +20,6 @@ module Onoma
           @options.any?
         end
 
-        def label
-          "create_item #{@nomenclature}##{@name}" + (@options.any? ? "(#{@options.simple_print})" : '')
-        end
-
         def human_name
           updates = []
           updates << "#{@name} as name"
@@ -31,7 +27,7 @@ module Onoma
           @options.each do |k, v|
             updates << "#{v} as #{k}"
           end
-          "Create item #{@nomenclature}##{@name} with " + updates.to_sentence
+          sentence = "Create item #{@nomenclature}##{@name} with " + updates.to_sentence
         end
       end
     end

data/lib/onoma/migration/actions/item_merging.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class ItemMerging < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :name, :into
@@ -10,10 +10,6 @@ module Onoma
           @into = element['into'].to_s
         end
 
-        def label
-          "merge_item #{@nomenclature}##{@name} into " + @into.to_s
-        end
-
         def human_name
           "Merge item #{@nomenclature}##{@name} into #{@into}"
         end

data/lib/onoma/migration/actions/item_removal.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class ItemRemoval < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :name

data/lib/onoma/migration/actions/nomenclature_change.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class NomenclatureChange < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :changes

data/lib/onoma/migration/actions/nomenclature_creation.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class NomenclatureCreation < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :options

data/lib/onoma/migration/actions/nomenclature_removal.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class NomenclatureRemoval < Onoma::Migration::Actions::Base
         attr_reader :nomenclature
@@ -11,10 +11,6 @@ module Onoma
 
         alias name nomenclature
 
-        def label
-          "remove_nomenclature #{@name}"
-        end
-
         def human_name
           "Remove nomenclature #{@name}"
         end

data/lib/onoma/migration/actions/property_creation.rb

@@ -1,5 +1,5 @@
 module Onoma
-  class Migration
+  module Migration
     module Actions
       class PropertyCreation < Onoma::Migration::Actions::Base
         attr_reader :nomenclature, :name, :type, :options
@@ -8,7 +8,7 @@ module Onoma
           @nomenclature = name.first
           @name = name.second
           @type = element['type'].to_sym
-          unless Property::TYPES.include?(@type)
+          unless Onoma::PROPERTY_TYPES.include?(@type)
             raise ArgumentError, "Property #{name} type is unknown: #{@type.inspect}"
           end
           @options = {}
@@ -18,7 +18,7 @@ module Onoma
           if element.has_attribute?('default')
             @options[:default] = element.attr('default').to_sym
           end
-          @options[:required] = !!(element.attr('required').to_s == 'true')
+          @options[:required] = element.attr('required').to_s == 'true'
           # @options[:inherit]  = !!(element.attr('inherit').to_s == 'true')
           if element.has_attribute?('choices')
             if type == :choice || type == :choice_list
@@ -35,7 +35,7 @@ module Onoma
           @options.each do |k, v|
             updates << "#{v} as #{k}"
           end
-          "Create property #{@nomenclature}.#{@name} with " + updates.to_sentence
+          sentence = "Create property #{@nomenclature}.#{@name} with " + updates.to_sentence
         end
       end
     end

data/lib/onoma/migration/base.rb

@@ -0,0 +1,38 @@
+module Onoma
+  module Migration
+    class Base
+      def self.parse(file)
+        f = File.open(file, 'rb')
+        document = Nokogiri::XML(f) do |config|
+          config.strict.nonet.noblanks.noent
+        end
+        f.close
+        root = document.root
+        number = file.basename.to_s.split('_').first.to_i
+        new(number, root['name'], root)
+      end
+
+      attr_reader :number, :name
+
+      def initialize(number, name, element = nil)
+        @number = number
+        @name = name
+        @actions = []
+        if element
+          element.children.each do |child|
+            next unless child.is_a? Nokogiri::XML::Element
+            @actions << "Onoma::Migration::Actions::#{child.name.underscore.classify}".constantize.new(child)
+          end
+        end
+      end
+
+      def each_action(&block)
+        @actions.each(&block)
+      end
+
+      def inspect
+        "#<#{self.class.name}:#{format('%#x', object_id)} ##{number} #{name.inspect} (#{@actions.size} actions)>"
+      end
+    end
+  end
+end

data/lib/onoma/migrator.rb

@@ -0,0 +1,13 @@
+module Onoma
+  module Migrator
+    class << self
+      def migrate
+        Onoma.missing_migrations.each do |migration|
+          puts migration.name
+          Onoma::Migrator::Reference.run(migration)
+          Onoma::Migrator::Translation.run(migration)
+        end
+      end
+    end
+  end
+end

data/lib/onoma/migrator/reference.rb

@@ -0,0 +1,71 @@
+module Onoma
+  module Migrator
+    class Reference
+      def self.run(migration)
+        ref = new
+        migration.each_action do |action|
+          ref.send(action.action_name, action)
+        end
+        ref.version = migration.number
+        puts "Write DB in #{Onoma.reference_path.relative_path_from(Onoma.root)}"
+        ref.write
+      end
+
+      def initialize
+        @set = if Onoma.reference_path.exist?
+                 Onoma::NomenclatureSet.load_file(Onoma.reference_path)
+               else
+                 Onoma::NomenclatureSet.new
+               end
+      end
+
+      def version
+        @set.version
+      end
+
+      def version=(number)
+        @set.version = number
+      end
+
+      def write
+        File.write(Onoma.reference_path, @set.to_xml)
+      end
+
+      def nomenclature_creation(action)
+        @set.add_nomenclature(action.name, action.options)
+      end
+
+      def nomenclature_change(action)
+        @set.change_nomenclature(action.nomenclature, action.changes)
+      end
+
+      def nomenclature_removal(action)
+        @set.remove_nomenclature(action.nomenclature)
+      end
+
+      def property_creation(action)
+        @set.add_property(action.nomenclature, action.name, action.type, action.options)
+      end
+
+      def property_change(action)
+        @set.add_property(action.nomenclature, action.name, action.changes)
+      end
+
+      def item_creation(action)
+        @set.add_item(action.nomenclature, action.name, action.options)
+      end
+
+      def item_change(action)
+        @set.change_item(action.nomenclature, action.name, action.changes)
+      end
+
+      def item_merging(action)
+        @set.merge_item(action.nomenclature, action.name, action.into)
+      end
+
+      def item_removal(action)
+        @set.remove_item(action.nomenclature, action.name)
+      end
+    end
+  end
+end