ygg 0.0.2 → 1.0.6

data/features/dsl.feature

@@ -0,0 +1,24 @@
+Feature: Ygg Domain Specific Language
+  In order to access ygg features easily
+  As a Ygg user
+  I want to have a nice DSL
+  
+  Background: All that from the other features
+    Given the class User has the field :name
+    And extends Record
+    And the class Account has the field :amount
+    And the class Account has the field :currency
+    And extends Record
+    And I have the file "emulations/samples/user.ygg"
+
+  Scenario: Data on session closed
+    When I load the file
+    And I ask User for records
+    Then I should get an user named "Xavier Via"
+  
+  Scenario: Giving path & identifier
+    Given the path "emulations/samples"
+    And the identifier :user
+    When I call ygg with those arguments
+    And I ask User for records
+    Then I should get an user named "Xavier Via"

data/features/events.feature

@@ -0,0 +1,17 @@
+Feature: Event managing
+  In order to recall data from past interactions
+  As an ygg user
+  I want to manage an event log
+  
+  Background: Setting up the enviroment
+    Given I have the base path "emulations/samples"
+    And the class User has the field :name
+  
+  Scenario: Accessing the last event
+    Given the file "emulations/samples/event.ygg" contains:
+      """
+      - !ruby/object:YggDemo::User
+        name: John Doe
+      """
+    When I interact with the resource :event
+    Then I should see that the last event loaded some User    

data/features/simple_record.feature

@@ -0,0 +1,40 @@
+Feature: Load and save a simple record from a file
+  In order to check Ygg's ability to manage record
+  As a Ygg developer
+  I want to load and save simple YAML records
+  
+  Scenario: Load a basic User record
+    Given the class User has the field :name
+    And the file "emulations/samples/user.ygg" contains:
+      """
+      - !ruby/object:YggDemo::User 
+        name: Xavier Via
+      """
+    When I load the file and get the records
+    Then the first record should be a User
+    And it should have the name "Xavier Via"
+   
+  @saves
+  Scenario: Save a basic User record
+    Given the class User has the field :name
+    And I have a user "Catalina" in an array
+    When I load the file "emulations/samples/saving.ygg" and add the array to the data
+    Then the file should contain:
+      """
+      - !ruby/object:YggDemo::User 
+        name: Catalina
+      """
+   
+  Scenario: Set a base folder and load files with symbols
+    Given I have the file "emulations/samples/user.ygg"
+    When I set "emulations/samples" as base folder
+    And I load :user
+    Then I should get non empty data
+  
+  Scenario: No block given, no data saved
+    Given the class User has the field :name
+    And I have the file "emulations/samples/user.ygg"
+    And I get its modified date
+    When I load it without block
+    Then I should get non empty data
+    And the file should not have been modified

data/features/steps/accessors.rb

@@ -0,0 +1,8 @@
+Given /^extends Record$/ do
+  @the_class.extend Ygg::Record
+end
+
+When /^I load the file and ask (.+?) for records$/ do |type|
+  @the_class = YggDemo.const_get type
+  @the_records = @the_class.from_ygg
+end

data/features/steps/dsl.rb

@@ -0,0 +1,20 @@
+Given /^the path "(.+?)"$/ do |path|
+  @argument_path = File.dirname(File.dirname(File.dirname(__FILE__)))
+  @argument_path += "/#{path}"
+end
+
+Given /^the identifier :(.+?)$/ do |identifier_name|
+  @the_identifier = identifier_name.to_sym
+end
+
+When /^I call ygg with those arguments$/ do
+  ygg @argument_path, @the_identifier
+end
+
+When /^I load the file$/ do
+  ygg @the_path
+end
+
+When /^I ask (.+?) for records$/ do |type|
+  @the_records = YggDemo.const_get(type).from_ygg
+end

data/features/steps/events.rb

@@ -0,0 +1,12 @@
+Given /^I have the base path "(.+?)"$/ do |path|
+  Ygg.base_dir = File.dirname(File.dirname(File.dirname(__FILE__))) +
+    "/#{path}"
+end
+
+When /^I interact with the resource :(.+?)$/ do |resource_name|
+  ygg resource_name.to_sym
+end
+
+Then /^I should see that the last event loaded some (.+?)$/ do |what|
+  ygg.events.last.should have_loaded_some(YggDemo.const_get(what))
+end

data/features/steps/simple_record.rb

@@ -0,0 +1,104 @@
+module YggDemo
+end
+
+# Given
+Given /the class (.+?) has the field :(.+?)$/ do |class_name, field_name|
+  if YggDemo.const_defined? class_name
+    @the_class = YggDemo.const_get class_name
+  else
+    @the_class = YggDemo.const_set class_name, Class.new
+  end
+  
+  @the_class.send :attr_accessor, field_name.to_sym
+end
+
+Given /the file "(.+?)" contains:/ do |path, content|
+  base_path = File.dirname(File.dirname(File.dirname(__FILE__)))
+  @the_path = "#{base_path}/#{path}"
+  @the_content = File.read @the_path
+  @the_content.should include(content)
+end
+
+Given /I have a user "(.+?)"/ do |user_name|
+  @the_user = YggDemo::User.new
+  @the_user.name = user_name
+end
+
+Given /^I have the file "(.+?)"$/ do |path|
+  base_path = File.dirname(File.dirname(File.dirname(__FILE__)))
+  @the_path = "#{base_path}/#{path}"
+  File.should exist(@the_path)
+end
+
+Given /^I get its modified date$/ do 
+  @last_modification_time = File.new(@the_path).mtime
+end
+
+# When
+When /I load the file and get the records/ do
+  @the_records = nil
+  ygg @the_path do
+    @the_records = records
+  end
+end
+
+When /^I load the file and request for objects of type (.+?)$/ do |type|
+  @the_records = nil
+  ygg @the_path do
+    @the_records = records.of_type YggDemo.const_get(type)
+  end
+end
+
+When /I load the file "(.+?)" and add the array to the data$/ do |file_name|
+  base_path = File.dirname(File.dirname(File.dirname(__FILE__)))
+  @the_path = "#{base_path}/#{file_name}"
+  ygg @the_path do
+    add @the_user
+  end
+end
+
+When /I set "(.+?)" as base folder/ do |path|
+  base_path = File.dirname(File.dirname(File.dirname(__FILE__)))
+  @base_dir = "#{base_path}/#{path}"
+  Ygg.base_dir = @base_dir
+end  
+
+When /^I load :([a-z]+?)$/ do |file|
+  @the_data = nil
+  ygg file.to_sym do
+    @the_data = records
+  end
+end
+
+When /^I load it without block$/ do
+  @the_data = ygg @the_path
+end
+
+# Them
+Then /the first record should be a (.+?)$/ do |type|
+  @first_record = @the_records.first
+  @first_record.should be_a(YggDemo.const_get(type))
+end
+
+Then /it should have the (.+?) "(.+?)"/ do |field_name, value|
+  @first_record.send(field_name.to_sym).should == value
+end
+
+Then /the file should contain:/ do |content|
+  File.should exist(@the_path)
+  @the_content = File.read @the_path
+  @the_content.should include(content)
+end
+
+Then /^I should get non empty data$/ do
+  @the_data.should_not be_empty
+end
+
+Then /^the file should not have been modified$/ do
+  @current_modification_time = File.new(@the_path).mtime
+  @current_modification_time.should == @last_modification_time
+end
+
+Then /^I should get an user named "(.+?)"$/ do |user_name|
+  @the_records.first.name.should == user_name
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path("../../../lib", __FILE__)
+require "ygg"

data/features/support/hooks.rb

@@ -0,0 +1,3 @@
+After "@saves" do
+  File.unlink @the_path
+end

data/lib/ygg.rb

@@ -1,5 +1,99 @@
-require "ygg/base"
+require "yaml"
+require "metafun/delegator"
 
-include Ygg::Delegator
+# Its time to start over. Bit by bit. Comment everything until
+# features and specs are supplied
 
-delegate Ygg, :save, :data, :load
+require "ygg/databundle"
+require "ygg/session"
+require "ygg/record"
+require "ygg/exceptions"
+
+module Ygg  
+  def self.reset
+    @@base_dir = "."
+    @@sessions = []
+  end
+
+  reset
+
+  def self.path_to( source )
+    if source.is_a? Symbol
+      return "#{@@base_dir}/#{source}.ygg"
+    else
+      return source
+    end
+  end
+
+  def self.transaction( source, &block )
+    if not block and not File.exist?(path_to(source))
+      raise UnavailableResourceException,
+        "No resource was found in #{path_to(source)}"
+    end
+
+    @@sessions << Session.new(path_to(source))
+
+    if block
+      @@within_block = true
+      yield block
+      @@within_block = nil
+      @@sessions.last.shutdown
+    end
+    return @@sessions.last.records
+  end
+
+  def self.ygg(*args, &block)
+    return Ygg if args.empty?
+
+    self.base_dir = args.shift if args.length > 1
+    source = args.shift
+
+    transaction(source, &block)
+  end
+
+  def self.add(*resources)
+    raise ArgumentError if resources.empty?
+
+    begin 
+      event = events.last
+      resources.each do |resource|
+        event.records << resource
+      end
+    rescue NoInteractionDoneException => e
+      raise UnavailableResourceException, "No resource was loaded, impossible to add the object"
+    end
+  end
+
+  def self.records
+    events.last.records
+  end
+
+  def self.base_dir=(dir)
+    @@base_dir = dir
+  end
+
+  def self.base_dir
+    @@base_dir
+  end
+
+  def self.events
+    raise NoInteractionDoneException, "No events to load in the log." if @@sessions.empty?
+    @@sessions
+  end
+  
+  def self.resource(*args)
+    if args.empty?
+      raise OutOfBlockException, "The resource is not available outside an ygg block." unless @@within_block
+      events.last
+    else
+      case args[0]
+        when :path
+          events.last.source
+      end
+    end
+  end
+end
+
+extend Metafun::Delegator
+
+delegate Ygg, :ygg, :records, :add

data/lib/ygg/bck/base.rb

@@ -0,0 +1,63 @@
+module Ygg
+  DEFAULT_SOURCE = "your_tree.ygg"
+
+  class Base
+    @@source = Ygg::DEFAULT_SOURCE
+    @@data = {}
+    
+    def self.load(source, &block)
+      Base.assign_source source if source
+      Base.assign_data if File.exists? @@source
+      
+      if block; yield; self.save; self.close; end
+    end
+  
+    def self.assign_source(source)
+      if source.is_a? Symbol then @@source = "#{source}.ygg"
+      else @@source = source
+    end
+    
+    def self.assign_data
+      @@data = YAML.load_file @@source
+      
+      # Clarify!
+      @@data.each do |key, model|      
+        model.each do |resource|
+          resource.loading! if resource.respond_to? :loading!
+        end if model.kind_of? Array
+      end
+    end
+    
+    def self.save
+      Base.finalize
+  
+      Base.write
+    end
+  
+    def self.finalize
+      @@data.each do |key, model|
+        model.each do |resource|
+          resource._finalize! if resource.respond_to? :_finalize!
+        end if model.kind_of? Array
+      end
+    end
+    
+    def self.data
+      @@data
+    end
+    
+    def self.close
+      @@data = nil
+    end
+    
+    def self.write
+      File.open @@source, "w" do |file|
+        file.write YAML.dump(@@data)
+      end
+    end
+  end
+
+  def self.ygg(source = nil, &block)
+    Base.load source, block
+  end
+end

data/lib/ygg/bck/branch.rb

@@ -0,0 +1,31 @@
+module Ygg
+  class Branch < 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 = Branch.new
+          self.each do |res|
+            if res.respond_to? key
+              datus = res.send key
+              result << res if datus == to_find
+            end
+          end
+          return Branch.new       if result.length == 0
+          return result[0]   if result.length == 1
+          return result
+        
+        else 
+          self.send(:"sort_by_#{key}")[0] unless empty?
+        end
+        
+        return Branch.new
+      end
+    end
+  end
+end

data/lib/ygg/bck/exceptions.rb

@@ -0,0 +1,3 @@
+module Ygg
+  class InvalidInitializor < RuntimeError; end
+end