ygg 0.0.1 → 0.0.2

data/README.rdoc

@@ -0,0 +1,57 @@
+= Ygg
+
+Lightweight YAML persistence solution with sofisticated ORM-class models and relationships.
+
+== Installation
+
+  gem install ygg
+
+== Usage
+
+  require "ygg"
+  
+  class User < Ygg::Model
+    attr_accessor :name, :pass
+  end
+  
+  class Article < Ygg::Model
+    attr_accessor :title, :content
+  end
+  
+  Ygg.load "data.yaml"
+  
+  user = User.create :index => "johnr",
+                     :name => "John Robertson",
+                     :pass => "secret"
+  
+  article = Article.create :index => "first-ygg"
+  article.title = "Using Ygg for the first time"
+  article.content = "The API is inspired in classic ORMs like ActiveRecord"
+  
+  user >> article # This declaration creations a relationships between the user and the article
+  
+  Ygg.save
+  
+And then for obtaining all articles belonging to "johnr"
+
+  # require and Model declarations here
+  
+  Ygg.load "data.yaml"
+  
+  puts User.get("johnr") >= Article
+  
+Further documentation on functions will be added when the core reaches some stability.
+
+= License
+
+(The MIT License)
+
+Copyright © 2011:
+
+* Xavier Via (http://germino.com.ar)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/ygg.rb

@@ -1,224 +1,5 @@
-require "yaml"
-require "singleton"
+require "ygg/base"
 
-module Ygg
+include Ygg::Delegator
 
-  # Mappers for simplicity
-  def self.load(file)
-    Ygg::DSL.instance.eagerly file
-  end
-  
-  def self.save
-    Ygg::DSL.instance.save
-  end
-  
-  def self.rel(*args)
-    Ygg::DSL.instance.rel *args
-  end
-  
-  module Delegator
-    def delegate(target, *methods)
-      methods.each do |method|
-        self.class.send :define_method, method do |*args, &block|
-          target.send method, *args, &block
-        end
-      end
-    end    
-  end
-  
-  class Relationship
-    attr_accessor :source
-    attr_accessor :target
-    
-    def initialize(source, target)
-      @source = source
-      @target = target
-    
-      short = Ygg::DSL.instance.data
-      short[:relationship] ||= []
-      short[:relationship] << self
-    end
-  end
-  
-  class DSL
-    include Singleton
-    
-    attr_accessor :data
-    attr_accessor :source
-    
-    def eagerly(source)
-      @source = source
-      if File.exists? @source
-        @data = YAML.load_file @source
-      else
-        @data = {}
-      end
-    end
-    
-    def save # Maybe get it better
-      source = @source if @source
-      unless source 
-        raise "There's already a file named 'ygg.yaml'." if File.exists? "ygg.yaml"
-        source = "ygg.yaml"
-      end
-      
-      File.open source, "w" do |file|
-        file.write YAML.dump @data
-      end
-    end
-    
-    def record(model, id)
-      model_sym = model.to_s.downcase.to_sym
-      @data[model_sym][id]
-    end
-    
-    def add(resource, son)
-      Ygg::Relationship.new resource, son
-    end
-
-    def _source(relation, resource, type = nil)
-      if relation.source == resource
-        if type == :all 
-          return relation.target
-        elsif relation.target.class == type
-          return relation.target
-        end
-      end
-      return false
-    end
-
-    def _target(relation, resource, type = nil)
-      if relation.target == resource
-        if type == :all
-          return relation.source
-        elsif relation.source.class == type
-          return relation.source
-        end
-      end
-      return false
-    end
-    
-    def rel(resource, options = {})
-      options[:as]    ||= :any
-      options[:type]  ||= :all
-      result = []
-      @data[:relationship].each do |relation|
-        args = [relation, resource, options[:type]]
-        case options[:as]
-          when :any
-            if res = _source(*args)
-              result <<  res
-            elsif res = _target(*args)
-              result << res
-            end
-          when :source
-            if res = _source(*args)
-              result << res
-            end
-          when :target
-            if res = _target(*args)
-              result << res
-            end        
-        end
-      end
-      result
-    end
-  end
-  
-  class Model
-    # Define methods for retrieving relations and 
-    # creating relations
-    
-    attr_accessor :index
-    
-    # Instance methods    
-    def >>(resource)
-      Ygg::DSL.instance.add self, resource
-    end
-
-    def <<(resource)
-      Ygg::DSL.instance.add resource, self
-    end
-    
-    def %(type)
-      if type == :all
-        Ygg::DSL.instance.rel self
-      elsif type.kind_of? Class
-        Ygg::DSL.instance.rel self, :type => type
-      end
-    end
-    
-    def >=(type)
-      if type == :all
-        Ygg::DSL.instance.rel self, :as => :source
-      elsif type.kind_of? Class
-        Ygg::DSL.instance.rel self, :as => :source, :type => type
-      end
-    end
-    
-    def <=(type)
-      if type == :all
-        Ygg::DSL.instance.rel self, :as => :target
-      elsif type.kind_of? Class
-        Ygg::DSL.instance.rel self, :as => :target, :type => type
-      end
-    end
-    
-    # Register this datus in the @data
-    def initialize(index)
-      Ygg::DSL.instance.data ||= {}
-      Ygg::DSL.instance.data[Ygg.symbolize(self)] ||= {}
-      if index.kind_of? String
-        Ygg::DSL.instance.data[Ygg.symbolize(self)][index] = self
-        @index = index
-      elsif index.kind_of? Hash
-        raise "Index missing" unless index[:index]
-        index.each do |key, value|
-          self.send "#{key}=".to_sym, value
-        end
-      end  
-    end
-    
-    # Class methods
-    def self.create(data)
-      if data.kind_of? Hash
-        raise "Index missing" unless data[:index]
-        index = data[:index]
-      elsif data.kind_of? String
-        index = data
-      end
-      instance = self.new index
-
-      if data.kind_of? Hash
-        data.each do |key, value|
-          instance.send "#{key}=".to_sym, value
-        end
-      end
-      Ygg::DSL.instance.save
-      instance
-    end
-    
-    def self.all
-      Ygg::DSL.instance.data[self.to_s.downcase.to_sym] ||= {}
-    end
-    
-    def self.get(index)
-      Ygg::DSL.instance.record(self, index)
-    end
-    
-    def self.related_to(datus, as = nil)
-      options = {}
-      options[:type] = self
-      options[:as] = as if as
-      Ygg::DSL.instance.rel datus, options
-    end
-  end
-  
-  def self.symbolize(object)
-    object.class.to_s.downcase.to_sym
-  end
-end
-
-#include Ygg::Delegator
-
-#delegate Ygg::DSL, :save, :record, :relateds
+delegate Ygg, :save, :data, :load

data/lib/ygg/base.rb

@@ -0,0 +1,224 @@
+require "yaml"
+
+module Ygg
+  @@data
+  @@source
+  
+  def self.load(source = "ygg.yaml", &block)
+  
+    if source.kind_of? Symbol
+      if File.exists? "#{source}.yml"
+        source = "#{source}.yml" 
+      else
+        source = "#{source}.yaml"
+      end
+    end
+    @@source ||= source if source == "ygg.yaml"
+    @@source = source   if source != "ygg.yaml"
+    
+    @@data = {}
+    @@data = YAML.load_file @@source if File.exists? @@source
+    
+    @@data.each do |key, model|      
+      model.each do |resource|
+        resource.loading! if resource.respond_to? :loading!
+      end if model.kind_of? Array
+    end
+    
+    if block; yield; self.save; self.close; end
+  end
+  
+  def self.save
+    @@data ||= {}
+    @@data.each do |key, model|
+      model.each do |resource|
+        resource._finalize! if resource.respond_to? :_finalize!
+      end if model.kind_of? Array
+    end
+    
+    File.open @@source, "w" do |file|
+      file.write YAML.dump(@@data)
+    end
+  end
+  
+  def self.close; @@data = nil; @@source; end
+  
+  def self.data; @@data ||= {}; end
+  
+  def self.symbolize(res)
+    return res.to_s.downcase.to_sym if res.kind_of? Class
+    res.class.to_s.downcase.to_sym
+  end
+    
+  class Model
+    @@validator = [/(.*)/, [:index]]
+  
+    def initialize(*args)
+      Ygg.data[Ygg.symbolize(self)] ||= []
+      Ygg.data[Ygg.symbolize(self)] << self
+      @created_at ||= Time.now    if respond_to? :created_at
+      @updated_at ||= Time.now    if respond_to? :updated_at
+      
+      if data = args.shift
+        if data.kind_of? Hash
+          data.each {|k,v| self.send(:"#{k}=", v) }
+        elsif data.kind_of? String
+          validator = self.class.validator
+          if matches = data.match(validator[0])
+            validator[1].each_index do |i|
+              self.send :"_#{validator[1][i]}=", matches[i+1]
+            end
+          else
+            raise Ygg::InvalidInitializor, "#{data} does not match the validation regexp for #{self.class}"
+          end
+        end
+      end
+    end
+
+    # Instance methods : Defaults
+    def _finalize!; finalize! if respond_to? :finalize!; end
+    def _loading!; loading! if respond_to? :loading!; end
+    def destroy
+      Ygg.data[Ygg.symbolize(self)].delete self
+      # Destroy all Links
+    end
+    def _id
+      Ygg.data[Ygg.symbolize(self)].index self
+    end
+    
+    # Instance methods : Links
+    def &(res)
+      Link.new :source => self, :target => res
+    end
+    def >(arg);           targets arg;                  end
+    def <(arg);           sources arg;                  end
+    def *(arg);           links arg;                    end
+    def links(arg = nil); targets(arg) + sources(arg);  end
+    
+    def targets(arg = nil)   # Test
+      links = Link.all.by_source self
+      return [] if links.kind_of? Array and links.empty?
+      links = [links] unless links.kind_of? Array
+      result = []
+      links.each do |link|
+        if arg  
+          if arg.kind_of? Class
+            result << link.target if link.target.class == arg
+          else
+            result << link.target if link.info == arg
+          end
+        else; result << link.target; end
+      end
+      result
+    end
+    
+    def sources(arg = nil)   # Test
+      links = Link.all.by_target self
+      return [] if links.kind_of? Array and links.empty?
+      links = [links] unless links.kind_of? Array
+      result = [] 
+      links.each do |link|
+        if arg
+          if arg.kind_of? Class
+            result << link.source if link.source.class == arg
+          else
+            result << link.source if link.info == arg
+          end
+        else; result << link.source; end
+      end
+      result
+    end
+    
+    def link_with(resource) # Test
+      links = Link.all.by_source self
+      return nil if links.kind_of? Array and links.empty?
+      links = [links] unless links.kind_of? Array
+      result = []
+      links.each do |link|
+        result << link if link.target == resource
+      end
+      
+      return false      if result.length == 0
+      return result[0]  if result.length == 1
+      return result
+    end
+    
+    # Class methods : Shorthands
+    def self.all; Ygg.data[Ygg.symbolize(self)]; end
+    def self.validator; @@validator; end
+    
+    # Class methods : Metamethods
+    def self.timestamps!; attr_accessor :created_at, :updated_at; end
+    
+    def self.key(*args)
+      attr_reader *args
+      args.each do |arg|
+        class_eval <<-_EOE
+          def _#{arg}=(v)
+            @#{arg} = v
+          end
+          
+          def _#{arg}_hook=(v)
+            @updated_at = Time.now if respond_to? :updated_at
+          end
+          
+          def #{arg}=(v)
+            self._#{arg}_hook = v
+            self._#{arg} = v
+          end
+        _EOE
+      end
+    end
+  end
+  
+  class Link < Model
+    attr_accessor :source, :target, :info
+    def &(data); @info = data; end
+  end
+  
+  class InvalidInitializor < RuntimeError; end
+  
+  module Delegator
+    def delegate(target, *methods)
+      methods.each do |method|
+        self.class.send :define_method, method do |*a, &b|
+          target.send method, *a, &b
+        end
+      end
+    end
+  end
+end
+
+class Array
+  def method_missing(x, *args)
+    if matches = x.to_s.match(/^sort_by_(.+)$/)
+      key = matches[1].to_sym
+      self.sort_by { |x| x.send(key) }
+
+    elsif matches = x.to_s.match(/^by_(.+)$/) # Extend with regexps
+      key = matches[1].to_sym
+      
+      if to_find = args.shift
+        result = []
+        self.each do |res|
+          if res.respond_to? key
+            datus = res.send key
+            result << res if datus == to_find
+          end
+        end
+        return []       if result.length == 0
+        return result[0]   if result.length == 1
+        return result
+      
+      else 
+        self.send(:"sort_by_#{key}")[0] unless empty?
+      end
+      
+      return []
+    end
+  end
+end
+
+#include Ygg::Delegator
+
+#delegate Ygg, :save, :data, :load

data/lib/ygg/version.rb

@@ -1,3 +1,3 @@
 module Ygg
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ygg
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-05-30 00:00:00.000000000 -03:00
+date: 2011-06-03 00:00:00.000000000 -03:00
 default_executable: 
 dependencies: []
 description: Pure Ruby persistence solution
@@ -21,8 +21,10 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.rdoc
 - Rakefile
 - lib/ygg.rb
+- lib/ygg/base.rb
 - lib/ygg/version.rb
 - ygg.gemspec
 has_rdoc: true