prepare a gem

README.textile → README.md

@@ -1,4 +1,4 @@
-h1. SerializedAttributes
+# SerializedAttributes
 
 SerializedAttributes allows you to add an encoded hash to an ActiveRecord model.  
 This is similar to the built-in ActiveRecord serialization, except that the field 
@@ -9,17 +9,22 @@ flexible, so you're stuck with strings/integers/dates/etc.
 Where possible, ActiveRecord compatible methods are generated so that a migration 
 should be pretty simple.  See unit tests for examples.
 
-Some of the code and most of the ideas are taken from "Heresy":http://github.com/kabuki/heresy/tree/master, 
-a ruby implementation of "how FriendFeed uses MySQL for schema-free storage":http://bret.appspot.com/entry/how-friendfeed-uses-mysql.
+Some of the code and most of the ideas are taken from [Heresy][Heresy], a ruby
+implementation of [how FriendFeed uses MySQL for schema-free storage][schemafree].
 
-h2. Setup
+Supports ActiveRecord 2.2 in ruby 1.8.7, and ActiveRecord 2.3-3.1 in ruby 1.9.3.
+
+[Heresy]: https://github.com/kabuki/heresy
+[schemafree]: http://bret.appspot.com/entry/how-friendfeed-uses-mysql
+
+## Setup
 
 Install the plugin into your Rails app.
 
-h2. Usage
+## Usage
 
-<pre><code>
-class Profile &lt; ActiveRecord::Base
+```ruby
+class Profile < ActiveRecord::Base
   # assumes #data serializes to raw_data blob field
   serialize_attributes do
     string  :title, :description
@@ -44,4 +49,5 @@ class Profile &lt; ActiveRecord::Base
     time    :birthday
   end
 end
-</code></pre>
+```
+

Rakefile

@@ -0,0 +1,134 @@
+#!/usr/bin/env rake
+
+require 'date'
+
+#############################################################################
+#
+# Helper functions
+#
+#############################################################################
+
+def name
+  @name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def version
+  line = File.read("lib/#{name}.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def rubyforge_project
+  name
+end
+
+def gemspec_file
+  "#{name}.gemspec"
+end
+
+def gem_file
+  "#{name}-#{version}.gem"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+#############################################################################
+#
+# Standard tasks
+#
+#############################################################################
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -r ./lib/#{name}.rb"
+end
+
+#############################################################################
+#
+# Custom tasks (add your own tasks here)
+#
+#############################################################################
+
+
+
+#############################################################################
+#
+# Packaging tasks
+#
+#############################################################################
+
+desc "Create tag v#{version} and build and push #{gem_file} to Rubygems"
+task :release => :build do
+  unless `git branch` =~ /^\* master$/
+    puts "You must be on the master branch to release!"
+    exit!
+  end
+  sh "git commit --allow-empty -a -m 'Release #{version}'"
+  sh "git tag v#{version}"
+  sh "git push origin master"
+  sh "git push origin v#{version}"
+  sh "gem push pkg/#{gem_file}"
+end
+
+desc "Build #{gem_file} into the pkg directory"
+task :build => :gemspec do
+  sh "mkdir -p pkg"
+  sh "gem build #{gemspec_file}"
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Generate #{gemspec_file}"
+task :gemspec => :validate do
+  # read spec file and split out manifest section
+  spec = File.read(gemspec_file)
+  head, manifest, tail = spec.split("  # = MANIFEST =\n")
+
+  # replace name version and date
+  replace_header(head, :name)
+  replace_header(head, :version)
+  replace_header(head, :date)
+  #comment this out if your rubyforge_project has a different name
+  replace_header(head, :rubyforge_project)
+
+  # determine file list from git ls-files
+  files = `git ls-files`.
+    split("\n").
+    sort.
+    reject { |file| file =~ /^\./ }.
+    reject { |file| file =~ /^(rdoc|pkg)/ }.
+    map { |file| "    #{file}" }.
+    join("\n")
+
+  # piece file back together and write
+  manifest = "  s.files = %w[\n#{files}\n  ]\n"
+  spec = [head, manifest, tail].join("  # = MANIFEST =\n")
+  File.open(gemspec_file, 'w') { |io| io.write(spec) }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Validate #{gemspec_file}"
+task :validate do
+  libfiles = Dir['lib/*'] - ["lib/#{name}.rb", "lib/#{name}"]
+  unless libfiles.empty?
+    puts "Directory `lib` should only contain a `#{name}.rb` file and `#{name}` dir."
+    exit!
+  end
+  unless Dir['VERSION*'].empty?
+    puts "A `VERSION` file at root level violates Gem best practices."
+    exit!
+  end
+end

init.rb

@@ -1,3 +1,2 @@
-$LOAD_PATH << File.dirname(__FILE__) + "/lib"
-require 'serialized_attributes'
-ActiveRecord::Base.extend SerializedAttributes::ModelMethods
+require File.expand_path('../rails_init', __FILE__)
+

lib/serializable_attributes.rb

@@ -0,0 +1,6 @@
+require File.expand_path('../serialized_attributes', __FILE__)
+module SerializedAttributes
+  VERSION = "0.9.0"
+end
+
+Object.const_set :SerializableAttributes, SerializedAttributes

lib/serialized_attributes.rb

@@ -32,18 +32,17 @@
 #   end
 #
 module SerializedAttributes
-  require 'serialized_attributes/types'
+  require File.expand_path('../serialized_attributes/types', __FILE__)
+  require File.expand_path('../serialized_attributes/schema', __FILE__)
 
   if nil.respond_to?(:duplicable?)
-    require 'serialized_attributes/duplicable'
+    require File.expand_path('../serialized_attributes/duplicable', __FILE__)
   end
 
   module Format
-    autoload :ActiveSupportJson, 'serialized_attributes/format/active_support_json'
+    autoload :ActiveSupportJson, File.expand_path('../serialized_attributes/format/active_support_json', __FILE__)
   end
 
-  autoload :Schema, 'serialized_attributes/schema'
-
   add_type :string,  String
   add_type :integer, Integer
   add_type :float,   Float

rails_init.rb

@@ -0,0 +1,3 @@
+require File.expand_path('../lib/serializable_attributes', __FILE__)
+ActiveRecord::Base.extend SerializedAttributes::ModelMethods
+

serializable_attributes.gemspec

@@ -0,0 +1,87 @@
+## This is the rakegem gemspec template. Make sure you read and understand
+## all of the comments. Some sections require modification, and others can
+## be deleted if you don't need them. Once you understand the contents of
+## this file, feel free to delete any comments that begin with two hash marks.
+## You can find comprehensive Gem::Specification documentation, at
+## http://docs.rubygems.org/read/chapter/20
+Gem::Specification.new do |s|
+  s.specification_version = 2 if s.respond_to? :specification_version=
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
+
+  ## Leave these as is they will be modified for you by the rake gemspec task.
+  ## If your rubyforge_project name is different, then edit it and comment out
+  ## the sub! line in the Rakefile
+  s.name              = 'faraday'
+  s.version           = '0.7.5'
+  s.date              = '2011-10-04'
+  s.rubyforge_project = 'faraday'
+
+  ## Make sure your summary is short. The description may be as long
+  ## as you like.
+  s.summary     = "Store a serialized hash of attributes in a single ActiveRecord column."
+  s.description = "A bridge between using AR and a full blown schema-free db."
+
+  ## List the primary authors. If there are a bunch of authors, it's probably
+  ## better to set the email to an email list or something. If you don't have
+  ## a custom homepage, consider using your GitHub URL or the like.
+  s.authors  = ["Rick Olson"]
+  s.email    = 'technoweenie@gmail.com'
+  s.homepage = 'http://github.com/technoweenie/serialized_attributes'
+
+  ## This gets added to the $LOAD_PATH so that 'lib/NAME.rb' can be required as
+  ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
+  s.require_paths = %w[lib]
+
+  s.add_dependency "activerecord", [">= 2.2.0", "< 3.2.0"]
+
+  ## Leave this section as-is. It will be automatically generated from the
+  ## contents of your Git repository via the gemspec task. DO NOT REMOVE
+  ## THE MANIFEST COMMENTS, they are used as delimiters by the task.
+  # = MANIFEST =
+  s.files = %w[
+    Gemfile
+    LICENSE.md
+    README.md
+    Rakefile
+    config.ru
+    faraday.gemspec
+    lib/faraday.rb
+    lib/faraday/adapter.rb
+    lib/faraday/adapter/action_dispatch.rb
+    lib/faraday/adapter/em_synchrony.rb
+    lib/faraday/adapter/excon.rb
+    lib/faraday/adapter/net_http.rb
+    lib/faraday/adapter/patron.rb
+    lib/faraday/adapter/test.rb
+    lib/faraday/adapter/typhoeus.rb
+    lib/faraday/builder.rb
+    lib/faraday/connection.rb
+    lib/faraday/error.rb
+    lib/faraday/middleware.rb
+    lib/faraday/request.rb
+    lib/faraday/request/json.rb
+    lib/faraday/request/multipart.rb
+    lib/faraday/request/url_encoded.rb
+    lib/faraday/response.rb
+    lib/faraday/response/logger.rb
+    lib/faraday/response/raise_error.rb
+    lib/faraday/upload_io.rb
+    lib/faraday/utils.rb
+    test/adapters/live_test.rb
+    test/adapters/logger_test.rb
+    test/adapters/net_http_test.rb
+    test/adapters/test_middleware_test.rb
+    test/connection_test.rb
+    test/env_test.rb
+    test/helper.rb
+    test/live_server.rb
+    test/middleware_stack_test.rb
+    test/request_middleware_test.rb
+    test/response_middleware_test.rb
+  ]
+  # = MANIFEST =
+
+  ## Test files will be grabbed from the file list. Make sure the path glob
+  ## matches what you actually use.
+  s.test_files = s.files.select { |path| path =~ %r{^test/*/.+\.rb} }
+end