ygg 0.0.2 → 1.0.6

data/lib/ygg/bck/link.rb

@@ -0,0 +1,6 @@
+module Ygg
+  class Link < Model
+    attr_accessor :source, :target, :info
+    def &(data); @info = data; end
+  end
+end

data/lib/ygg/{base.rb → bck/model.rb}

@@ -1,61 +1,11 @@
-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
+      Ygg.data[self.class] ||= []
+      Ygg.data[self.class] << self
       @created_at ||= Time.now    if respond_to? :created_at
       @updated_at ||= Time.now    if respond_to? :updated_at
       
@@ -79,11 +29,11 @@ module Ygg
     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
+      Ygg.data[self.class].delete self
       # Destroy all Links
     end
     def _id
-      Ygg.data[Ygg.symbolize(self)].index self
+      Ygg.data[self.class].index self
     end
     
     # Instance methods : Links
@@ -144,7 +94,7 @@ module Ygg
     end
     
     # Class methods : Shorthands
-    def self.all; Ygg.data[Ygg.symbolize(self)]; end
+    def self.all; Ygg.data[self.class]; end
     def self.validator; @@validator; end
     
     # Class methods : Metamethods
@@ -170,55 +120,5 @@ module Ygg
       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
+end

data/lib/ygg/databundle.rb

@@ -0,0 +1,25 @@
+module Ygg
+  class DataBundle
+    def initialize(source_array = nil)
+      @data = source_array || []
+    end
+    
+    def of_type(type)
+      @result = DataBundle.new
+      @data.each do |resource|
+        @result << resource if resource.instance_of? type
+      end
+      return @result.empty? ? nil : @result
+    end    
+    
+    # Delegate to array
+    def first; @data.first; end
+    def empty?; @data.empty?; end
+    def <<(*args); @data.<<(*args); end
+    def to_yaml; @data.to_yaml; end
+    def include?(*args); @data.include?(*args); end
+    def each(&block); @data.each { |e| block.call(e) }; end
+    def length; @data.length; end
+    def last; @data.last; end
+  end
+end

data/lib/ygg/exceptions.rb

@@ -0,0 +1,6 @@
+module Ygg
+  class NoInteractionDoneException < StandardError; end
+  class UnavailableResourceException < IOError; end
+  class OutOfBlockException < StandardError; end
+  class InvalidResourceException < StandardError; end
+end

data/lib/ygg/record.rb

@@ -0,0 +1,7 @@
+module Ygg  
+  module Record
+    def from_ygg
+      Ygg.records.of_type self
+    end
+  end
+end

data/lib/ygg/session.rb

@@ -0,0 +1,44 @@
+module Ygg
+  class Session
+    def initialize(source = nil)
+      if source
+        @source = source
+        @records = DataBundle.new load
+      end
+    end
+
+    def load(path = nil)
+      @source = path if path
+      begin
+        File.exists?(@source) ? YAML.load_file(@source) : []
+      rescue Psych::SyntaxError => syntax_error
+        raise InvalidResourceException,
+          "The resource on #{@source} is invalid"
+      end
+    end
+
+    def shutdown
+      File.open @source, "w" do |file|
+        file.write @records.to_yaml
+      end
+    end
+
+    def source
+      raise Ygg::UnavailableResourceException, "No resource was setted." unless @source
+      @source
+    end
+    
+    def source=(source); @source = source; end
+    def records; @records; end
+    
+    def has_loaded_some?(of_class)
+      raise ArgumentError, "Not a class" unless of_class.is_a? Class
+      raise NoInteractionDoneException, 
+        "No interaction done yet." unless records
+      records.each do |record|
+        return true if record.is_a? of_class
+      end
+      return false
+    end
+  end
+end

data/lib/ygg/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,61 @@
+require "ygg"
+
+module YggDemo
+  class User
+    attr_accessor :name
+  end
+  
+  class Account
+    attr_accessor :currency, :amount
+  end
+end
+
+def base_path
+  File.dirname(File.dirname(__FILE__))
+end
+def folder_path
+  "emulations/samples"
+end
+def full_base_path
+  "#{base_path}/#{folder_path}"
+end
+
+def non_existent_file_identifier; :non_existent; end
+def non_existent_file_path 
+  "#{folder_path}/#{non_existent_file_identifier}.ygg"
+end
+def non_existent_full_path
+  "#{base_path}/#{non_existent_file_path}"
+end
+def valid_file_identifier; :valid; end
+def valid_file_path; "#{valid_file_identifier}.ygg"; end
+def valid_full_path; "#{full_base_path}/#{valid_file_path}"; end
+def to_create_file_identifier; :to_create; end
+def to_create_file_path; "#{to_create_file_identifier}.ygg"; end
+def to_create_full_path; "#{full_base_path}/#{to_create_file_path}"; end
+
+def to_modify_file_identifier; :to_modify; end
+def to_modify_file_path; "#{to_modify_file_identifier}.ygg"; end
+def to_modify_full_path
+  "#{full_base_path}/#{to_modify_file_path}"
+end
+
+def to_modify_2_file_identifier; :to_modify_2; end
+def to_modify_2_file_path; "#{to_modify_2_file_identifier}.ygg"; end
+def to_modify_2_full_path
+  "#{full_base_path}/#{to_modify_2_file_path}"
+end
+
+def invalid_resource_file_identifier; :invalid_resource; end
+def invalid_resource_file_path; "#{invalid_resource_file_identifier}.ygg"; end
+def invalid_resource_full_path
+  "#{full_base_path}/#{invalid_resource_file_path}"
+end
+
+def user_file_identifier; :user; end
+def user_file_path; "#{user_file_identifier}.ygg"; end
+def user_full_path; "#{full_base_path}/#{user_file_path}"; end
+
+def the_last_object_of(resource_path)
+  YAML.load_file(resource_path).last
+end

data/spec/ygg/databundle_spec.rb

@@ -0,0 +1,54 @@
+require "spec_helper"
+
+describe Ygg::DataBundle do
+  describe "#of_type" do
+    context "no data" do
+      it "should return nil" do
+        the_databundle = Ygg::DataBundle.new
+        the_databundle.of_type(Object).should be_nil
+      end
+    end
+    
+    context "data but nothing of that type" do
+      it "should return nil" do
+        the_databundle = Ygg::DataBundle.new ['element']
+        the_databundle.of_type(Array).should be_nil
+      end
+    end
+
+    context "one object of that kind" do
+      it "should return a databundle with the object" do
+        the_databundle = Ygg::DataBundle.new ['element', 4]
+        the_databundle.of_type(String).should include('element')
+      end
+    end
+  end
+  
+  describe "#which_are" do
+    pending # return "#is_a?"
+  end
+  
+  context "Non empty inner array" do
+    before :each do 
+      @the_databundle = Ygg::DataBundle.new ['element']
+    end
+
+    describe "#first"    
+    describe "#empty?"
+    describe "#<<"
+    describe "#to_yaml"
+    describe "#include?"
+  end
+  
+  context "Empty inner array" do
+    before :each do
+      @the_databundle = Ygg::DataBundle
+    end
+    
+    describe "#first"
+    describe "#empty?"
+    describe "#<<"
+    describe "#to_yaml"
+    describe "#include?"
+  end
+end

data/spec/ygg/session_spec.rb

@@ -0,0 +1,203 @@
+require "spec_helper"
+
+describe Ygg::Session do
+  def should_be_invalid(resource)
+    File.should exist(resource)
+    expect { YAML.load_file resource
+    }.to raise_error( Psych::SyntaxError )
+  end
+  
+  def it_should_not_include_a(type, file_path)
+    data = YAML.load_file(file_path)
+    data.each do |record|
+      raise "It includes a #{type}" if record.is_a? type
+    end
+  end
+  
+  def it_should_include_a(type, file_path)
+    data = YAML.load_file(file_path)
+    data.each do |record|
+      return if record.is_a? type
+    end
+    raise "It does not includes a #{type}" 
+  end
+
+  before :each do
+    @path = File.dirname(File.dirname(File.dirname(__FILE__)))
+    should_be_invalid invalid_resource_full_path
+  end
+
+  describe ".new" do
+    it "should return a new session" do
+      @session = Ygg::Session.new "#{@path}/emulations/samples/user.ygg"
+    end
+    
+    context "an invalid resource is passed" do
+      it "should fail" do
+        expect { Ygg::Session.new invalid_resource_full_path
+        }.to raise_error(
+          Ygg::InvalidResourceException,
+          "The resource on #{invalid_resource_full_path} is invalid" )
+      end
+    end
+  end
+    
+  describe "#records" do
+    context "the file has the user Xavier Via" do
+      before :each do
+        @session = Ygg::Session.new "#{@path}/emulations/samples/user.ygg"
+        @the_record = @session.records.first
+      end
+      
+      it "should not be empty the session data" do
+        @session.records.should_not be_empty
+      end
+      
+      it "should be a record of type User" do
+        @the_record.should be_a(YggDemo::User)
+      end
+      
+      it "should be named Xavier Via" do
+        @the_record.name.should == "Xavier Via"
+      end
+    end
+    
+    context "the file is empty" do
+      it "should be empty the session data" do
+        @session = Ygg::Session.new "#{@path}/emulations/samples/random.ygg"
+        @session.records.should be_empty
+      end
+    end
+  end
+  
+  describe "#shutdown" do
+    before :each do 
+      @source = "#{@path}/emulations/samples/random.ygg"
+      @session = Ygg::Session.new @source
+    end
+    
+    context "a string has been added to the data" do
+      before :each do
+        @session.records << "Hello data!"
+        @session.shutdown
+      end
+      
+      it "should create a file after the source" do
+        File.should exist(@source)
+      end
+      
+      it "should include the string in the file" do
+        @content = File.read @source
+        @content.should include("Hello data!")
+      end
+      
+      after :each do
+        File.unlink @source
+      end
+    end
+  end
+  
+  describe "#source" do
+    it "should fail if no source specified" do
+      session = Ygg::Session.new
+      expect { session.source
+      }.to raise_error( Ygg::UnavailableResourceException,
+        "No resource was setted." )
+    end
+    
+    it "should return something" do
+      pending "dunno how to define what must return"
+    end
+  end
+  
+  describe "#source=" do
+    it "should setup the source" do
+      session = Ygg::Session.new
+      session.source = valid_full_path
+      session.source.should == valid_full_path
+    end
+    
+    it "should change the previous source" do
+      session = Ygg::Session.new
+      session.source = valid_full_path
+      expect { session.source = to_modify_full_path
+      }.to change { session.source 
+      }.from( valid_full_path ).to( to_modify_full_path )
+    end
+  end
+  
+  describe "#load" do
+    context "if no argument is passed" do
+      it "should fail if the argument is not a valid YAML stream" do
+        session = Ygg::Session.new
+        session.source = invalid_resource_full_path
+        expect { session.load
+        }.to raise_error(
+          Ygg::InvalidResourceException,
+          "The resource on #{invalid_resource_full_path} is invalid" )
+      end
+    end
+    
+    context "an argument is passed" do
+      it "should override @source" do
+        session = Ygg::Session.new valid_full_path
+        expect { session.load to_modify_full_path
+        }.to change { session.source 
+        }.from(valid_full_path).to(to_modify_full_path)
+      end
+      
+      it "should fail if the argument is not a valid YAML stream" do
+        session = Ygg::Session.new
+        expect { session.load invalid_resource_full_path 
+        }.to raise_error(
+          Ygg::InvalidResourceException,
+          "The resource on #{invalid_resource_full_path} is invalid" )
+      end
+    end
+    
+    context "the source is a non existent file" do
+      it "should return an empty array" do
+        File.should_not exist( non_existent_full_path )
+        session = Ygg::Session.new non_existent_full_path
+        session.load.should be_empty
+      end
+    end
+    
+    context "the source is a valid YAML stream" do
+      it "should return the object from the last document" do
+        the_last_object_of(user_full_path).should be_a(YggDemo::Account)
+      end
+    end
+  end
+  
+  describe "#has_loaded_some?" do
+    it "should fail on no argument" do
+      expect { Ygg::Session.new.has_loaded_some?
+      }.to raise_error( ArgumentError )
+    end
+    
+    it "should fail if argument is not a class" do
+      expect { Ygg::Session.new.has_loaded_some? (Object.new)
+      }.to raise_error( ArgumentError, "Not a class" )
+    end
+    
+    it "should fail if no loading has been done" do
+      expect { Ygg::Session.new.has_loaded_some? (Object)
+      }.to raise_error( 
+        Ygg::NoInteractionDoneException,
+        "No interaction done yet." )
+    end
+    
+    it "should return false if there is no object of that type" do
+      it_should_not_include_a Array, user_full_path
+      session = Ygg::Session.new user_full_path
+      session.should_not have_loaded_some(Array)
+    end
+    
+    it "should return true if there is some object of that type" do
+      it_should_include_a YggDemo::User, user_full_path
+      session = Ygg::Session.new user_full_path
+      session.should have_loaded_some(YggDemo::User)
+    end
+  end
+end