file_record 0.1.0

data/.gitignore

@@ -0,0 +1,12 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/pids/
+test/dummy/tmp/cache/
+test/dummy/tmp/sessions/
+test/dummy/tmp/sockets/
+test/dummy/tmp/file_records/*
+*~
+*.swp

data/.rvmrc

@@ -0,0 +1 @@
+rvm ruby-1.9.2-p180@file_record

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,107 @@
+PATH
+  remote: .
+  specs:
+    file_record (0.1.0)
+      rails (~> 3.0.4)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.4)
+      actionpack (= 3.0.4)
+      mail (~> 2.2.15)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+    activesupport (3.0.4)
+    arel (2.0.8)
+    builder (2.1.2)
+    capybara (0.4.1.1)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.7)
+    childprocess (0.1.6)
+      ffi (~> 0.6.3)
+    culerity (0.2.15)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    json_pure (1.5.1)
+    mail (2.2.15)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.4)
+      actionmailer (= 3.0.4)
+      actionpack (= 3.0.4)
+      activerecord (= 3.0.4)
+      activeresource (= 3.0.4)
+      activesupport (= 3.0.4)
+      bundler (~> 1.0)
+      railties (= 3.0.4)
+    railties (3.0.4)
+      actionpack (= 3.0.4)
+      activesupport (= 3.0.4)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.8.7)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.2)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3 (1.3.3)
+    sqlite3-ruby (1.3.3)
+      sqlite3 (>= 1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.24)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  file_record!
+  sqlite3-ruby

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Michal Taszycki
+
+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/README.md

@@ -0,0 +1,66 @@
+FileRecord
+==========
+
+Simplistic implementation of persistent model library. 
+Inspired by ActiveRecord. And fully compatible with ActiveModel.
+
+Created alongside the presentation [Digging into Rails 3.x internals - ActiveModel][0]
+
+Installation
+------------
+
+    git clone git://github.com/mehowte/file_record.git
+    cd file_record
+    bundle install
+
+Documentation
+------------
+
+1. See [the presentation][0]
+
+2. Look into 
+    test 
+and 
+    test/dummy directory.
+
+Running tests
+-------
+
+    rake
+
+Running demo app
+--------
+    cd test/dummy
+    rails server
+
+... and then visit [addresses index on localhost](http://localhost:3000/addresses)
+
+models will be saved into 
+    
+    test/dummy/tmp/file_records
+
+License
+-------
+Copyright 2011 Michal Taszycki
+
+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.
+
+[0]: http://rails-3-internals-active-model.heroku.com/
+

data/Rakefile

@@ -0,0 +1,31 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FileRecord'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+Bundler::GemHelper.install_tasks
+

data/file_record.gemspec

@@ -0,0 +1,23 @@
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name = "file_record"
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michał Taszycki"]
+  s.homepage    = "https://github.com/mehowte/file_record"
+  s.description = "Insert FileRecord description."
+  s.summary     = %q{Simplistic implementation of persistent model library. }
+  s.description = %q{Simplistic implementation of persistent model library. Inspired by ActiveRecord. And fully compatible with ActiveModel.}
+  s.rubyforge_project = "file_record"
+  
+  s.add_dependency "rails", "~> 3.0.4"
+  s.add_development_dependency "capybara"
+  s.add_development_dependency "sqlite3-ruby"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.version = "0.1.0"
+end

data/lib/file_record/attribute_management.rb

@@ -0,0 +1,32 @@
+module FileRecord
+  module AttributeManagement
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :_attribute_names 
+      self._attribute_names = []
+
+      attr_reader :attributes
+    end
+
+    def attributes=(attributes)
+      @attributes = attributes
+      sanitize_attributes
+
+    end
+
+    def sanitize_attributes
+      @attributes.keep_if do |name, value| 
+        self.class._attribute_names.include? name.to_sym
+      end
+    end
+
+    module ClassMethods
+      def attributes(*attribute_names)
+        self._attribute_names += attribute_names
+        self._attribute_names.uniq!
+      end
+    end
+
+  end
+end

data/lib/file_record/attribute_methods/all.rb

@@ -0,0 +1,11 @@
+module FileRecord
+  module AttributeMethods
+    module All
+      extend ActiveSupport::Concern
+      include Read
+      include Write
+      include Validation
+      include Dirty
+    end
+  end
+end

data/lib/file_record/attribute_methods/dirty.rb

@@ -0,0 +1,22 @@
+module FileRecord
+  module AttributeMethods
+    module Dirty
+      extend ActiveSupport::Concern
+
+      include ActiveModel::Dirty
+
+      def save
+        if status = super
+          @previously_changed = changes
+          @changed_attributes.clear
+        end
+        status
+      end
+
+      def attribute=(name, value)
+        attribute_will_change!(name) if attributes[name] != value
+        super(name, value)
+      end
+    end
+  end
+end

data/lib/file_record/attribute_methods/read.rb

@@ -0,0 +1,24 @@
+module FileRecord
+  module AttributeMethods
+    module Read
+      extend ActiveSupport::Concern
+      include ActiveModel::AttributeMethods
+
+      included do
+        attribute_method_prefix ""
+      end
+      module ClassMethods
+        def attributes(*args)
+          super(*args)
+          define_attribute_methods args
+        end
+      end
+
+      protected
+      def attribute(name)
+        @attributes[name]
+      end
+
+    end
+  end
+end

data/lib/file_record/attribute_methods/validation.rb

@@ -0,0 +1,17 @@
+module FileRecord
+  module AttributeMethods
+    module Validation
+      extend ActiveSupport::Concern
+      include ActiveModel::AttributeMethods
+
+      included do
+        attribute_method_affix :prefix => 'is_', :suffix => "_valid?"
+      end
+
+      protected
+      def is_attribute_valid?(attribute)
+        valid? || errors[attribute].empty?
+      end
+    end
+  end
+end

data/lib/file_record/attribute_methods/write.rb

@@ -0,0 +1,22 @@
+module FileRecord
+  module AttributeMethods
+    module Write
+      extend ActiveSupport::Concern
+      include ActiveModel::AttributeMethods
+
+      included do
+        attribute_method_prefix "clear_"
+        attribute_method_suffix "="
+      end
+
+      protected
+      def attribute=(name, value)
+        @attributes[name] = value
+      end
+
+      def clear_attribute(attribute)
+        send(:"#{attribute}=", nil)
+      end
+    end
+  end
+end

data/lib/file_record/attribute_methods.rb

@@ -0,0 +1,10 @@
+module FileRecord
+  module AttributeMethods
+    autoload :Read, 'file_record/attribute_methods/read'
+    autoload :Write, 'file_record/attribute_methods/write'
+    autoload :Validation, 'file_record/attribute_methods/validation'
+    autoload :Dirty, 'file_record/attribute_methods/dirty'
+    autoload :All, 'file_record/attribute_methods/all'
+  end
+  
+end

data/lib/file_record/base.rb

@@ -0,0 +1,19 @@
+module FileRecord
+  class Base
+
+    include AttributeManagement
+    include Persistence
+    include Validations
+    include Callbacks
+    include AttributeMethods::All
+    include Compatibility
+
+    attributes :id
+    validates :id, :presence => true
+
+    def initialize(attributes = {})
+      self.attributes = attributes 
+    end
+  end
+end
+

data/lib/file_record/callbacks.rb

@@ -0,0 +1,20 @@
+module FileRecord
+  module Callbacks
+    extend ActiveSupport::Concern
+    included do
+      extend ActiveModel::Callbacks
+      include ActiveModel::Validations::Callbacks
+
+      define_model_callbacks :save, :destroy
+    end 
+
+
+    def save
+      run_callbacks(:save) { super }
+    end
+
+    def destroy
+      run_callbacks(:destroy) { super }
+    end
+  end
+end

data/lib/file_record/compatibility.rb

@@ -0,0 +1,11 @@
+module FileRecord
+  module Compatibility
+    extend ActiveSupport::Concern
+
+    included do    
+      extend ActiveModel::Naming
+      extend ActiveModel::Translation
+      include ActiveModel::Conversion
+    end
+  end
+end

data/lib/file_record/persistence.rb

@@ -0,0 +1,53 @@
+module FileRecord
+  module Persistence
+    extend ActiveSupport::Concern
+    include ActiveModel::Serializers::JSON
+
+    module ClassMethods
+      def find(name)
+        if File.exists? filename(name)
+          self.new.from_json(File.read(filename(name)))
+        else
+          nil 
+        end
+      end
+
+      def all
+        Dir.new(Rails.root + "tmp/file_records").entries.reject do |name|
+          File.directory?(name)  
+        end.map do |name|
+          find(name)
+        end
+      end
+      
+    def create(attributes = {})
+      obj = self.new(attributes)
+      obj.save ? obj : nil
+    end
+
+      def filename(name)
+        Rails.root + "tmp/file_records/" + name
+      end
+    end
+
+    def persisted?
+      id && File.exists?(self.class.filename(id))
+    end
+
+
+    def save
+        File.open(self.class.filename(id), 'w') {|f| f.write(to_json) } 
+    end
+
+
+    def destroy
+      File.delete(self.class.filename(id)) if persisted?
+    end
+
+    def update_attributes(attributes)
+      @attributes.merge!(attributes)
+      sanitize_attributes
+      save
+    end
+  end
+end

data/lib/file_record/validations.rb

@@ -0,0 +1,15 @@
+module FileRecord
+  module Validations
+    extend ActiveSupport::Concern
+    include ActiveModel::Validations
+
+    def save
+      if valid?
+        super
+        true
+      else
+        false
+      end
+    end
+  end
+end

data/lib/file_record.rb

@@ -0,0 +1,9 @@
+module FileRecord
+  autoload :Base, 'file_record/base'
+  autoload :AttributeMethods, 'file_record/attribute_methods'
+  autoload :AttributeManagement, 'file_record/attribute_management'
+  autoload :Persistence, 'file_record/persistence'
+  autoload :Validations, 'file_record/validations'
+  autoload :Callbacks, 'file_record/callbacks'
+  autoload :Compatibility, 'file_record/compatibility'
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/addresses_controller.rb

@@ -0,0 +1,83 @@
+class AddressesController < ApplicationController
+  # GET /addresses
+  # GET /addresses.json
+  def index
+    @addresses = Address.all
+
+    respond_to do |format|
+      format.html # index.html.erb
+      format.json  { render :json => @addresses }
+    end
+  end
+
+  # GET /addresses/1
+  # GET /addresses/1.json
+  def show
+    @address = Address.find(params[:id])
+
+    respond_to do |format|
+      format.html # show.html.erb
+      format.json  { render :json => @address }
+    end
+  end
+
+  # GET /addresses/new
+  # GET /addresses/new.json
+  def new
+    @address = Address.new
+
+    respond_to do |format|
+      format.html # new.html.erb
+      format.json  { render :json => @address }
+    end
+  end
+
+  # GET /addresses/1/edit
+  def edit
+    @address = Address.find(params[:id])
+  end
+
+  # POST /addresses
+  # POST /addresses.json
+  def create
+    @address = Address.new(params[:address])
+
+    respond_to do |format|
+      if @address.save
+        format.html { redirect_to(@address, :notice => 'Address was successfully created.') }
+        format.json  { render :json => @address, :status => :created, :location => @address }
+      else
+        format.html { render :action => "new" }
+        format.json  { render :json => @address.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # PUT /addresses/1
+  # PUT /addresses/1.json
+  def update
+    @address = Address.find(params[:id])
+
+    respond_to do |format|
+      if @address.update_attributes(params[:address])
+        format.html { redirect_to(@address, :notice => 'Address was successfully updated.') }
+        format.json  { head :ok }
+      else
+        format.html { render :action => "edit" }
+        format.json  { render :json => @address.errors, :status => :unprocessable_entity }
+      end
+    end
+  end
+
+  # DELETE /addresses/1
+  # DELETE /addresses/1.json
+  def destroy
+    @address = Address.find(params[:id])
+    @address.destroy
+
+    respond_to do |format|
+      format.html { redirect_to(addresses_url) }
+      format.json  { head :ok }
+    end
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/addresses_helper.rb

@@ -0,0 +1,2 @@
+module AddressesHelper
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/address.rb

@@ -0,0 +1,10 @@
+class Address < FileRecord::Base
+    def initialize(attributes = {})
+      super(attributes)
+    end
+
+  attributes :street, :house_number
+
+  validates :street, :house_number, :presence => true
+  validates :house_number, :numericality => true
+end