Permalink
Browse files

Updated README and CHANGELOG files.

  • Loading branch information...
1 parent ca41d2b commit 8c0995ba5580961499b03eb0edd0066392ce65f1 @weppos committed Feb 8, 2009
Showing with 39 additions and 57 deletions.
  1. +5 −1 LICENSE.rdoc
  2. +20 −13 README.rdoc
  3. +14 −22 Rakefile
  4. +0 −21 TODO
View
@@ -1,4 +1,8 @@
-Copyright (c) 2008 Simone Carletti <weppos@weppos.net>
+= License
+
+(The MIT License)
+
+Copyright (c) 2008-2009 Simone Carletti <weppos@weppos.net>
Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
View
@@ -1,6 +1,6 @@
= ActiveRecord::MultiConditions
-MultiConditions is a simple ActiveRecord plugin for storing ActiveRecord query conditions and make complex queries painless.
+MultiConditions is a simple ActiveRecord plugin for storing ActiveRecord find conditions and make complex queries painless.
== Overview
@@ -56,7 +56,11 @@ First, don't forget to require the library.
Now +MultiConditions+ object is automatically available as subclass of any ActiveRecord object.
- class Task < ActiveRecord::Base; end
+ class Task < ActiveRecord::Base
+
+ # your Task model
+
+ end
multiconditions = Task::Multiconditions.new
# => new instance
@@ -166,25 +170,28 @@ but you *MUST* initialize a MultiConditions instance from a Model.
* {Simone Carletti}[http://www.simonecarletti.com/] <weppos@weppos.net>
-If you like this software, please {recommend me}[http://www.workingwithrails.com/person/11967-simone-carletti] at Working with Rails.
-
-== Website and Project Home
+== Resources
-* {Project Homepage}[http://code.simonecarletti.com/multiconditions]
-* {At GitHub}[http://github.com/weppos/activerecord-multiconditions/]
-* {At RubyForge}[http://rubyforge.org/projects/multiconditions/]
+* {Homepage}[http://code.simonecarletti.com/multiconditions]
+* {API}[http://multiconditions.rubyforge.org/]
+* {GitHub}[http://github.com/weppos/activerecord-multiconditions/]
+* {RubyForge}[http://rubyforge.org/projects/multiconditions/]
== FeedBack and Bug reports
-Feel free to email {Simone Carletti}[mailto:weppos@weppos.net]
-with any questions or feedback.
+Feel free to email {Simone Carletti}[mailto:weppos@weppos.net] with any questions or feedback.
-Please submit your bug reports to the Redmine installation for MultiConditions
-available at http://code.simonecarletti.com/activerecord-multiconditions.
+Please use the {Ticket System}[http://code.simonecarletti.com/projects/show/multiconditions] to submit bug reports or feature request.
== Changelog
-See CHANGELOG file.
+See the CHANGELOG.rdoc file for details.
+
+
+== License
+
+Copyright (c) 2008-2009 Simone Carletti, ActiveRecord::MultiConditions is released under the MIT license.
+
View
@@ -1,51 +1,43 @@
require 'rubygems'
+require 'rake'
require 'echoe'
$LOAD_PATH.unshift(File.dirname(__FILE__) + "/lib")
require 'multi_conditions'
# Common package properties
-PKG_NAME = ENV['PKG_NAME'] || ActiveRecord::Base::MultiConditions::GEM
+PKG_NAME = ENV['PKG_NAME'] || ActiveRecord::Base::MultiConditions::GEM
PKG_VERSION = ENV['PKG_VERSION'] || ActiveRecord::Base::MultiConditions::VERSION
PKG_SUMMARY = "An ActiveRecord plugin for dealing with complex search :conditions."
-PKG_FILES = FileList.new("{lib,test}/**/*.rb") do |fl|
- fl.exclude 'TODO'
+PKG_FILES = FileList.new("{lib,test}/**/*.rb") do |fl|
fl.include %w(README.rdoc CHANGELOG.rdoc LICENSE.rdoc)
fl.include %w(Rakefile setup.rb)
end
RUBYFORGE_PROJECT = 'activerecord-multiconditions'
-
-# Prepare version number, don't forget about snapshots!
-version = PKG_VERSION
if ENV['SNAPSHOT'].to_i == 1
- version << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
+ PKG_VERSION << "." << Time.now.utc.strftime("%Y%m%d%H%M%S")
end
-Echoe.new(PKG_NAME, version) do |p|
- p.author = "Simone Carletti"
- p.email = "weppos@weppos.net"
+Echoe.new(PKG_NAME, PKG_VERSION) do |p|
+ p.author = "Simone Carletti"
+ p.email = "weppos@weppos.net"
p.summary = PKG_SUMMARY
- p.description = <<-EOF
+ p.description = <<-EOD
MultiConditions is a simple ActiveRecord plugin \
for storing ActiveRecord query conditions and make complex queries painless.
- EOF
+ EOD
p.url = "http://code.simonecarletti.com/activerecord-multiconditions"
+ p.project = RUBYFORGE_PROJECT
- p.version = PKG_VERSION
- p.changes = ''
-
- p.dependencies = ['activerecord >=2.0.0']
- p.rcov_options = ["-xRakefile"]
-
- p.need_zip = true
- p.include_rakefile = true
+ p.need_zip = true
+ p.rcov_options = ["-x Rakefile -x rcov"]
+ p.rdoc_pattern = /^(lib|CHANGELOG.rdoc|README.rdoc)/
- p.project = RUBYFORGE_PROJECT
+ p.runtime_dependencies += ['activerecord >=2.0.0']
- p.rdoc_pattern = /^(lib|CHANGELOG.rdoc|LICENSE.rdoc|README.rdoc)/
end
View
21 TODO
@@ -1,21 +0,0 @@
-= TODO
-
-* improve tests in order to use real queries instead of simple statements
-
-* add tests for different ActiveRecord versions
-
-* ... more
-
-* configure a Redmine installation to store TODO list! :)
-
-== m02
-
-* store conditions as an array of condition
-
-* ability to identify a condition by :name ( append_condition(condition, :name), condition? :name, remove_condition :name ... )
-
-== m03
-
-* ability to tag conditions (condition group)
-
-* ability to remove, search, manage condition by tag

0 comments on commit 8c0995b

Please sign in to comment.