dir_model 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55a68864ee18333c18a59e6e8a8331aedf90ed0f
-  data.tar.gz: cf8dee9636172ce581287536d1bc903ec155690a
+  metadata.gz: 3a463aecfe9ed4b92a734acdca662de128f7e342
+  data.tar.gz: 512616906b07badd6ee5ebb1b4a3c797d6a8cade
 SHA512:
-  metadata.gz: edbca7458a28490260d7f50495e10540ed6cfad0422bbdede0aaeb8d01393a33f7c4ddded2c4d2207784823b2615e0de887863c8217e3400e33c0f323882ce60
-  data.tar.gz: 73bd59243eaffcd38e75522434cf5f40a3014efc6556df4bb90214992a0066fb600d53f8037c8b7e8634d79407f45ace2e80c63a8ae6db20754896153da6db1b
+  metadata.gz: e46872a46024038ba6997fe2b4967f9e85f349f5f58ede009bc17eaf8ccc47d47c47243e714cd91a936525c3eea646d1afaf59f5987ee4007cf08408052b9cac
+  data.tar.gz: 9fdf00b25d1318468b1907f4ad574b8e5a98e1f776fb7c3524ad29549bd17cb8f7ffcdbf097808d8be409e6d01810463b3c94e4e5bc3b66bb8b44be6d3e9be64

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+### VERSION 0.5.0
+
+* Add relation has_one to a dir_model
+* `file:` must be unique, you can't defined several file in the same dir_model
+* Simplification of `lib/dir_model/import.rb`
+
+### VERSION 0.4.0
+### VERSION 0.3.4
+### VERSION 0.3.3
+### VERSION 0.3.2
+
 ### VERSION 0.3.1
 
 * Technical changes, Simplication of Path, use Array skill to give previous, current and next Path instead of using Enumerator

data/README.md

@@ -23,7 +23,7 @@ Or install it yourself as:
 ### Import
 
 ```ruby
-class ImageDir
+class BasicDirModel
   include DirModel::Model
 
   file :image, regex: -> { /Zones\/Sector_(?<sector_id>.*)\/Zone_(?<zone_id>.*)\.(?<extension>png|jpg)/i }
@@ -35,33 +35,48 @@ named matches are available under `matches[:sector_id]` or directly when you cal
 An implementation possible of Import
 
 ```ruby
-class ImageImportDir < ImageDir
+class BasicImportDirModel < BasicDirModel
   include DirModel::Import
 
-  def assign!
-    model.send(method, image)
-  end
-
   protected
 
   def model
     Project.find(context[:project_id]).sectors.find(sector_id).zones.find(zone_id)
   end
-
-  def method
-    :blueprint
-  end
 end
 ```
 
 You can have access at the file through
 
-`ImageImportDir.new(source_path, project_id: 42).image`
+`BasicImportDirModel.new(source_path, project_id: 42).image`
+
+#### Relation
+
+A dir_model can have a relation like `has_one` basically is
+
+```ruby
+class ChildImportDirModel
+  include DirModel::Model
+  include DirModel::Import
+  file :metadata, regex: -> { /Zones\/Sector_(?<sector_id>.*)\/Zone_(?<zone_id>.*)\.(?<extension>json)/i }
+end
+```
+
+```ruby
+class ParentImportDirModel < BasicImportDirModel
+  has_one :dependency, ChildImportDirModel
+end
+```
+
+```ruby
+parent_instance.dependency # => ChildImportDirModel
+child.parent # => parent_instance
+```
 
 ### Export
 
 ```ruby
-class ImageDir
+class BasicDirModel
   include DirModel::Model
 
   file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { image_name }
@@ -73,7 +88,7 @@ end
 If you don't know the extension of your image it will be automatically discover, but this works only for image so if you send, for instance, a json file you have to explicitly provide extension on the `:name` options
 
 ```ruby
-class ImageExportDir < ImageDir
+class BasicExportDirModel < BasicDirModel
   include DirModel::Export
 
   def dir
@@ -106,7 +121,7 @@ fixture_models = [
   })
 ]
 
-exporter = DirModel::Export::AggregateDir.new(ImageExportDir)
+exporter = DirModel::Export::AggregateDir.new(BasicExportDirModel)
 
 exporter.generate do |dir|
   models.each { |model| dir << model }
@@ -119,7 +134,7 @@ an skip? method based on the name of file :image is create, this method is named
 
 default implementation
 ```
-def image_skip?
+def skip?
   image.present?
 end
 ```
@@ -128,7 +143,7 @@ NOTE Safe to override on your Exporter
 In fact this is equivalent to
 
 ```
-def image_skip?
+def skip?
   source_model.zone.present?
 end
 ```
@@ -155,15 +170,3 @@ def image_extension
 end
 ```
 Otherwise return nil, safe to override on your Exporter
-
-## zip_dir
-Use [`zip_dir`](https://github.com/FinalCAD/zip_dir) to zip DirModel::Export instances:
-```ruby
-# Zip
-zipper = ZipDir::Zipper.new
-zip_file = zipper.generate do |z|
-  z.add_and_cleanup_dir __dir_model_export__
-end
-```
-
-**Ensure that `require zip_dir` occurs before `dir_model` (for now)**

data/UPGRADE.md

@@ -1,8 +1,8 @@
 # Upgrading
 
-# Upgrading from 0.3.0 to 0.3.1
+# Upgrading from 0.4.0 to 0.5.0
 
-* Nothing todo
+* Ensure you have only on definition of `file:` by dir_model
 
 # Upgrading from 0.2.0 to 0.3.0
 
@@ -25,7 +25,7 @@ end
 for a DirModel
 
 ```
-class ImageDir
+class BasicDirModel
   include DirModel
 
   file :image, path: -> { "#{dir}/#{sub_dir}" }, name: -> { "#{image_name}.png" }

data/lib/dir_model/export/files.rb

@@ -4,11 +4,9 @@ module DirModel
       extend ActiveSupport::Concern
 
       included do
-        self.file_names.each do |*args|
-          define_skip_method(*args)
-          define_file_method(*args)
-          define_extension_method(*args)
-        end
+        define_skip_method(self.file_name)
+        define_file_method(self.file_name)
+        define_extension_method(self.file_name)
       end
 
       module ClassMethods
@@ -18,7 +16,7 @@ module DirModel
         # Define default skip method for a file
         # @param file_name [Symbol] the file: name
         def define_skip_method(file_name)
-          define_method("#{file_name}_skip?") do
+          define_method(:skip?) do
             !self.public_send(file_name).try(:present?)
           end
         end

data/lib/dir_model/export.rb

@@ -32,20 +32,19 @@ module DirModel
     def generate
       cleanup if generated?
 
-      self.class.file_names.each do |file_name|
-        options = self.class.options(file_name)
+      file_name = self.class.file_name
+      options   = self.class.options
 
-        next if self.send("#{file_name}_skip?")
+      return if self.send(:skip?)
 
-        dir_path  = get_value_of(options[:path])
-        file_path = File.join(dir_path, get_value_of(options[:name]))
+      dir_path  = get_value_of(options[:path])
+      file_path = File.join(dir_path, get_value_of(options[:name]))
 
-        mkdir { File.join(@root_path, dir_path) }
+      mkdir { File.join(@root_path, dir_path) }
 
-        file_path = ensure_extension(file_path, file_name)
+      file_path = ensure_extension(file_path, file_name)
 
-        File.open(File.join(@root_path, file_path), 'wb') {|f| f.write(self.public_send(file_name).read) }
-      end
+      File.open(File.join(@root_path, file_path), 'wb') {|f| f.write(self.public_send(file_name).read) }
     ensure
       @generated = true
     end
@@ -60,7 +59,7 @@ module DirModel
       ext ||= FastImage.type(self.public_send(file_method_name))
       unless ext
         # You have to provide an extension i.e name: 'file.json
-        raise StandardError.new("options :name should provide an extension")
+        raise StandardError.new("extension guessing failed, please provide explicit extension in :name option")
       end
 
       file_path_with_extension = file_path + '.' + ext.to_s

data/lib/dir_model/import/path.rb

@@ -6,8 +6,8 @@ module DirModel
       attr_reader :index
       attr_reader :current_path
 
-      def initialize(path)
-        @path, @index = path, -1
+      def initialize(dir_path)
+        @path, @index = dir_path, -1
         reset!
       end
 
@@ -44,6 +44,14 @@ module DirModel
         set_end unless current_path
         current_path
       end
+      
+      def set_position(index)
+        @index = index
+      end
+      
+      def rewind
+        set_position(-1)
+      end
 
       protected
 

data/lib/dir_model/import.rb

@@ -5,15 +5,11 @@ module DirModel
     attr_reader :context, :source_path, :index, :previous
 
     def initialize(path, options={})
+      super # set parent
       @source_path, @context = path, OpenStruct.new(options[:context])
-      @index, @previous = options[:index], options[:previous].try(:dup)
-      @load_state = :ghost
-      @file_infos = {}
-    end
-
-    def matches
-      load
-      file_infos[:options][:match]
+      @index, @previous      = options[:index], options[:previous].try(:dup)
+      @load_state            = :ghost
+      @file_infos            = {}
     end
 
     def skip?
@@ -23,15 +19,27 @@ module DirModel
 
     def method_missing(name, *args, &block)
       load
-      matches[name]
-    rescue IndexError
+      @_match[name]
+    rescue
       super
     end
 
     module ClassMethods
       def next(path, context={}, previous=nil)
         path.read_path
-        new(path.current_path, index: path.index, context: context, previous: previous)
+        dir_model = new(path.current_path, index: path.index, context: context, previous: previous)
+
+        if dir_model.has_relations?
+          current_position = path.index
+          path.rewind
+          loop do # loop until find related file (has_one relation)
+            path.read_path
+            break if dir_model.append_dir_model(path.current_path, index: path.index, context: context)
+          end
+          path.set_position(current_position)
+        end
+        
+        dir_model
       end
     end
 
@@ -41,28 +49,12 @@ module DirModel
 
     def match?
       return if load_state == :loaded
-      @_match = loader { find_match }
+      @_match = find_match.tap { @load_state = :loaded }
     end
     alias_method :load, :match?
 
     def find_match
-      self.class.file_names.each do |file_name|
-        options = self.class.options(file_name)
-
-        if match = (source_path||'').match(options[:regex].call)
-          @file_infos = { file: file_name, options: options.merge(match: match) }
-          return true
-        end
-      end
-      false
+      @_match = (source_path||'').match(self.class.options[:regex].call)
     end
-
-    def loader
-      @load_state = :loading
-      result = yield
-      @load_state = :loaded
-      result
-    end
-
   end
 end

data/lib/dir_model/model/files.rb

@@ -10,26 +10,27 @@ module DirModel
 
       module ClassMethods
         # @return [Array<Symbol>] file names for the row model
-        def file_names
-          files.keys
+        def file_name
+          files.keys.first
         end
 
         # @param [Symbol] file_name name of file to find option
         # @return [Hash] options for the file_name
-        def options(file_name)
+        def options
           files[file_name]
         end
 
         # @param [Symbol] file_name name of file to find index
         # @return [Integer] index of the file_name
         def index(file_name)
-          file_names.index file_name
+          0
         end
 
         protected
 
         def file(file_name, options={})
           merge_files(file_name.to_sym => options)
+          raise ArgumentError.new("You cannot define more of one file: but you can add relations, see README") if files.keys.size > 1
         end
 
       end

data/lib/dir_model/model/relations.rb

@@ -0,0 +1,67 @@
+module DirModel
+  module Model
+    module Relations
+      extend ActiveSupport::Concern
+      included do
+        inherited_class_hash :has_one_relationship
+      end
+      
+      # @return [Boolean] returns true, if the instance is a child
+      def child?
+        !!parent
+      end
+      
+      def has_relations?
+        has_one?
+      end
+
+      # Appends model to the parent and returns it
+      #
+      # @return [Model] return the child if it is valid, otherwise returns nil
+      def append_dir_model(source_path, options={})
+        relation_name = self.class.has_one_relationship.keys.first
+        related_class = self.class.has_one_relationship.values.first
+
+        related_dir_model = related_class.new(source_path, options.reverse_merge(parent: self))
+        
+        unless related_dir_model.skip?
+          public_send("#{relation_name}=", related_dir_model)
+          related_dir_model
+        else
+          nil
+        end
+      end
+
+      def has_one?
+        false
+      end
+      
+      class_methods do
+        # Defines a relationship between a dir model
+        #
+        # @param [Symbol] relation_name the name of the relation
+        # @param [DirModel::Import] dir_model_class class of the relation
+        def has_one(relation_name, dir_model_class)
+          raise "for now, DirModel's has_one may only be called once" if @_has_one_relationship.present?
+
+          relation_name = relation_name.to_sym
+
+          merge_has_one_relationship(relation_name => dir_model_class)
+          
+          define_method(:has_one?) do
+            true
+          end
+          
+          define_method("#{relation_name}=") do |value|
+            instance_variable_set("@#{relation_name}", value)
+          end
+
+          define_method(relation_name) do
+            instance_variable_get("@#{relation_name}")
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/dir_model/model.rb

@@ -5,6 +5,18 @@ module DirModel
     included do
       include Utils
       include Files
+      include Relations
+      
+      # @return [Model] return the parent, if this instance is a child
+      attr_reader :parent
     end
+    
+    # @param [NilClass] path not used here, see {Input}
+    # @param [Hash] options
+    # @option options [String] :parent if the instance is a child, pass the parent
+    def initialize(path=nil, options={})
+      @parent = options[:parent]
+    end
+
   end
 end

data/lib/dir_model/version.rb

@@ -1,3 +1,3 @@
 module DirModel
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/dir_model.rb

@@ -8,6 +8,7 @@ require 'dir_model/utils'
 
 require 'dir_model/model'
 require 'dir_model/model/files'
+require 'dir_model/model/relations'
 
 require 'dir_model/export/files'
 require 'dir_model/export'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dir_model
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Steve Chung
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-12-09 00:00:00.000000000 Z
+date: 2015-12-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,7 @@ files:
 - lib/dir_model/import/path.rb
 - lib/dir_model/model.rb
 - lib/dir_model/model/files.rb
+- lib/dir_model/model/relations.rb
 - lib/dir_model/utils.rb
 - lib/dir_model/version.rb
 homepage: https://github.com/FinalCAD/dir_model