serialist 0.1.0 → 0.2.0

data/README.rdoc

@@ -5,7 +5,7 @@ Add one serializable field in your table, and let serialist do the rest.
 
 === Before :
 
-  class Article
+  class Article < ActiveRecord::Base
     serialize :preferences
   end
   
@@ -17,7 +17,7 @@ Add one serializable field in your table, and let serialist do the rest.
   
 === After : 
 
-  class Article
+  class Article < ActiveRecord::Base
     serialist :preferences, [:key, :other_key, :yet_another_key]
   end
 
@@ -38,6 +38,24 @@ Add one serializable field in your table, and let serialist do the rest.
   $ ./script/server
   $ GoTo localhost:3000 and create an article
   
+== Or generate a migration for your existing programm
+
+./script/generate serialist SerialistMigration MyModel my_serialist_attribute
+Ex : 
+
+  ./script/generate serialist SerialistMigration Article slug
+  
+Then hook Serialist into your ActiveRecord model : 
+
+  serialist :my_serialist_attribute, [:foo, :bar]
+  # OR
+  serialist :my_serialist_attribute
+  # See below
+  
+  # Add validation as you normally would :
+  validates_presence_of :bar
+  # etc.
+  
 == Serialist comes in 2 flavors:
 
 === Specific declaration (safe, use define_method)
@@ -58,25 +76,25 @@ Allows you to serialize only the desired keys. ex :
 
 === Catch-all with method_missing
 
-  you should probably choose to load serialist after your other plugins/gems, because ActiveRecord won't fire NoMethodError anymore on Serialisted models, and some plugin may want to catch it to implement their own auto-magic (=== find_all_by_title_and_description kind of magic)
+You should probably choose to load serialist after your other plugins/gems, because ActiveRecord won't fire NoMethodError anymore on Serialisted models, and some plugin may want to catch it to implement their own auto-magic (=== find_all_by_title_and_description kind of magic)
 
-    # in your model. my_serializer_attribute is the one you specify in the migration
+  # in your model. my_serializer_attribute is the one you specify in the migration
 
-    serialist :my_serializer_attribute              
+  serialist :my_serializer_attribute              
 
-  Allows you to serialize anything. ex : 
+Allows you to serialize anything. ex : 
 
-    $ ./script/console
-    >> a = Article.new
-    => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
-    >> a.foo = "hello"
-    => "hello"
-    >> a.foo?("hello")
-    => true
-    >> a.foo
-    => "hello"
-    >> a
-    => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
+  $ ./script/console
+  >> a = Article.new
+  => #<Article id: nil, title: nil, created_at: nil, updated_at: nil, slug: nil>
+  >> a.foo = "hello"
+  => "hello"
+  >> a.foo?("hello")
+  => true
+  >> a.foo
+  => "hello"
+  >> a
+  => #<Article id: XX, title: nil, created_at: "..", updated_at: "..", slug: {:foo=>"hello"}>
 
 == Word of caution:
 

data/TODO.txt

@@ -0,0 +1 @@
+* tests

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/generators/serialist/serialist_generator.rb

@@ -0,0 +1,18 @@
+class SerialistGenerator < Rails::Generator::NamedBase
+  attr_accessor :class_name, :migration_name, :migrated_table, :serialist_attribute
+  
+  def initialize(args, options = {})
+    super
+    @class_name = args[0]
+    @migrated_table = args[1]
+    @serialist_attribute = args[2]
+  end
+  
+  def manifest
+    @migration_name = file_name.camelize
+    record do |m|
+      # Migration creation
+      m.migration_template "migrate/serialist_migration.rb.erb", "db/migrate", :migration_file_name => migration_name.underscore
+    end
+  end 
+end

data/generators/serialist/templates/USAGE

@@ -0,0 +1,3 @@
+script/generate serialist MigrationName MyModel my_serialist_attribute
+  
+This will create a migration to use serialist on MyModel with :my_serialist_attribute

data/generators/serialist/templates/migrate/serialist_migration.rb.erb

@@ -0,0 +1,9 @@
+class <%= migration_name %> < ActiveRecord::Migration
+  def self.up
+    add_column :<%= migrated_table.to_s.underscore.pluralize %>, :<%= serialist_attribute.to_s %>, :text
+  end
+  
+  def self.down
+    remove_column :<%= migrated_table.to_s.underscore.pluralize %>, :<%= serialist_attribute.to_s %>
+  end
+end

data/installation-template.txt

@@ -0,0 +1,70 @@
+gem 'serialist'
+
+generate :scaffold, "article title:string"
+generate :serialist, "SerialistMigration", "Article", "slug"
+
+rake "db:migrate"
+
+file "app/models/article.rb", <<-END
+  class Article < ActiveRecord::Base
+    serialist :slug, [:required_serialized_value, :another_serialized_value]
+    validates_presence_of :title
+    validates_presence_of :required_serialized_value
+  end
+END
+
+file "app/views/articles/edit.html.erb", <<-END
+<h1>Editing article</h1>
+<%= render :partial => "form" %>
+<%= link_to 'Show', @article %> |
+<%= link_to 'Back', articles_path %>
+END
+
+file "app/views/articles/new.html.erb", <<-END
+<h1>New article</h1>
+<%= render :partial => "form" %>
+<%= link_to 'Back', articles_path %>
+END
+
+file "app/views/articles/_form.html.erb", <<-END
+<% form_for(@article) do |f| %>
+  <%= f.error_messages %>
+  <p>
+    <%= f.label :title %><br />
+    <%= f.text_field :title %>
+  </p>
+  <p>
+    <%= f.label :required_serialized_value %><br />
+    <%= f.text_field :required_serialized_value %>
+  </p>
+  <p>
+    <%= f.label :another_serialized_value %><br />
+    <%= f.text_field :another_serialized_value %>
+  </p>
+  <p>
+    <%= f.submit 'Send' %>
+  </p>
+<% end %>
+END
+
+file "app/views/articles/show.html.erb", <<-END
+<p>
+  <b>Title:</b>
+  <%=h @article.title %>
+</p>
+<p>
+  <b>Required serialized value:</b>
+  <%=h @article.required_serialized_value %>
+</p>
+<p>
+  <b>Another serialized value:</b>
+  <%=h @article.another_serialized_value %>
+</p>
+
+<%= link_to 'Edit', edit_article_path(@article) %> |
+<%= link_to 'Back', articles_path %>
+END
+
+run "rm app/views/layouts/articles.html.erb"
+run "rm public/index.html"
+route "map.root :controller => 'articles'"

data/lib/serialist.rb

@@ -1,79 +1,2 @@
-# ActsAsSerializable
-module Serialist
-  
-  def self.included(base)
-    base.extend ClassMethods
-  end
-
-  module ClassMethods
-    attr_accessor :serialist_options
-    attr_accessor :serialist_field
-
-    def serialist(serialist_field, serialist_options = [])
-      
-      
-      @serialist_field ||= serialist_field
-      @serialist_options ||= []
-      @serialist_options = (@serialist_options + serialist_options).uniq
-      serialize(@serialist_field, Hash)
-      
-      if serialist_options.empty?
-        include Serialist::InstanceMethods
-      else
-        @serialist_options.each do |field|
-          define_method field.to_s do 
-            return nil unless (slug = self.send(serialist_field))
-            slug[field]
-          end
-          define_method field.to_s + "?" do |*param|
-            return false unless (slug = self.send(serialist_field))
-            if param.empty?
-              ![nil, false, "false", :false].include?(slug[field])
-            else
-              slug[field] == param.first
-            end
-          end
-          define_method field.to_s + "=" do |param|
-            update_attribute(serialist_field, Hash.new) unless self.send(serialist_field)
-            self.send(serialist_field)[field] = param
-          end
-        end
-      end
-    end
-    
-    def inherited(subclass)
-      super
-      subclass.instance_variable_set("@serialist_field", @serialist_field)
-      subclass.instance_variable_set("@serialist_options", @serialist_options)
-    end
-  end
-  
-  module InstanceMethods
-    def method_missing(method, *args, &block)
-      begin
-        super
-      rescue NoMethodError
-        slug = self.send(self.class.serialist_field)
-        
-        case method.to_s.last
-        when "?"
-          slug && slug[method.to_s[0..-2].to_sym] == (args && args.first || "true")
-          
-          if args.empty?
-            slug && ![nil, false, "false", :false].include?(slug[method.to_s[0..-2].to_sym])
-          else
-            slug && (slug[method.to_s[0..-2].to_sym] == args.first)
-          end
-          
-        when "="
-          update_attribute(self.class.serialist_field, Hash.new) unless slug
-          self.send(self.class.serialist_field)[method.to_s[0..-2].to_sym] = args.first
-        else
-          slug && slug[method]
-        end
-      end
-    end
-  end
-end
-
-
+require 'serialist/serialist_module'
+ActiveRecord::Base.send(:include, Serialist)

data/rails/init.rb

@@ -0,0 +1 @@
+require 'serialist'

data/serialist.gemspec

@@ -0,0 +1,57 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{serialist}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Benoit B\303\251n\303\251zech"]
+  s.date = %q{2009-09-09}
+  s.description = %q{Serialize any data, set and fetch it like any column attributes}
+  s.email = %q{benoit.benezech@gmail.com}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "TODO.txt",
+     "VERSION",
+     "generators/serialist/serialist_generator.rb",
+     "generators/serialist/templates/USAGE",
+     "generators/serialist/templates/migrate/serialist_migration.rb.erb",
+     "init.rb",
+     "install.rb",
+     "installation-template.txt",
+     "lib/serialist.rb",
+     "rails/init.rb",
+     "serialist.gemspec",
+     "tasks/acts_as_serializable_tasks.rake",
+     "test/acts_as_serializable_test.rb",
+     "test/test_helper.rb",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/bbenezech/serialist}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Serialize any data, set and fetch it like any column attributes}
+  s.test_files = [
+    "test/acts_as_serializable_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: serialist
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - "Benoit B\xC3\xA9n\xC3\xA9zech"
@@ -25,9 +25,17 @@ files:
 - MIT-LICENSE
 - README.rdoc
 - Rakefile
+- TODO.txt
+- VERSION
+- generators/serialist/serialist_generator.rb
+- generators/serialist/templates/USAGE
+- generators/serialist/templates/migrate/serialist_migration.rb.erb
 - init.rb
 - install.rb
+- installation-template.txt
 - lib/serialist.rb
+- rails/init.rb
+- serialist.gemspec
 - tasks/acts_as_serializable_tasks.rake
 - test/acts_as_serializable_test.rb
 - test/test_helper.rb