redis-messages 0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+0.1 (January 25, 2010)
+Doing initial Redis messages generator, will be a swift move to 1.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2010 Seivan Heidari
+
+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.
+By reading this fine print your soul is now the exclusive property of WeDoBDD Productions and its Subsidiaries.
+Unauthorized use of seivan gems, images, materials, souls, odors and oxygen is strongly discouraged. We know where you sleep.
+Also, your mum & bring back prop8

data/README.rdoc

@@ -0,0 +1,21 @@
+== Install
+
+  gem install redis-messages
+
+== Rails 3
+
+To use redis-messages with Rails 3 you will need to include it in your Gemfile.
+
+group :development do
+  gem "redis-messages"
+end
+
+== Usage
+== Included Generators
+* rails g redis_messages  : Will name keys and models as User and Message and the Redis constant to R
+  
+* rails g redis_messages letter user : Assuming the User model already exist, this will inject code into it and create a Letter model.
+
+* rails g redis_messages letter player Red : Creates a Letter and Player model and names the Redis constant to Red
+
+* And don't forget to run your migrations since we also utilize SQL here.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'rake'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format progress"
+end
+
+task :default => :features

data/features/redis_messages_named.feature

@@ -0,0 +1,35 @@
+Feature: Redis Messages Generator With Named Models
+  In order to send letters to multiple users
+  As a rails developer
+  I want to generate a messaging library using letters as a name
+
+
+  Scenario: Generate named messages
+    Given a new Rails app
+    When I run "rails g redis_messages letters players Red"
+    Then I should see the following files
+       | app/models/letter.rb          |
+     # | app/helpers/messages_helper.rb |
+       | db/migrate                     |
+	And I should see "class Letter < ActiveRecord::Base" in file "app/models/letter.rb"
+	And I should see "belongs_to :player" in file "app/models/letter.rb"
+  
+	And I should see "Red.smembers(Letter.receivers_for(self.id))" in file "app/models/letter.rb"
+	And I should see "Red.sadd(Letter.inbox_for(username), self.id)" in file "app/models/letter.rb"
+    And I should see "Red.sadd(Letter.receivers_for(self.id), username)" in file "app/models/letter.rb"
+  
+  	And I should see "def self.inbox_for(username)" in file "app/models/letter.rb"
+  	And I should see "("letter:#{username}:inbox")" in file "app/models/letter.rb"
+  
+  	And I should see "def self.receivers_for(letter_id)" in file "app/models/letter.rb"
+  	And I should see "("letter:#{letter_id}:receivers")" in file "app/models/letter.rb"
+	
+	And I should see the following files
+		|app/models/player.rb|
+	And I should see "class Player < ActiveRecord::Base" in file "app/models/player.rb"
+	And I should see "has_many :letters" in file "app/models/player.rb"
+	And I should see "letter_ids = Red.smembers(Letter.inbox_for(self.username))" in file "app/models/player.rb"
+	And I should see "Letter.where(:visible => true, :id => letter_ids).order("created_at DESC")" in file "app/models/player.rb"
+
+	And I should see "self.letters(:visible => true)" in file "app/models/player.rb"
+	And I should not see file "temp_file.rb"

data/features/redis_messages_standard.feature

@@ -0,0 +1,48 @@
+Feature: Redis Messages Generator
+  In order to send messages to multiple users
+  As a rails developer
+  I want to generate a messaging library
+
+  Scenario: Generate default messages
+    Given a new Rails app
+    When I run "rails g redis_messages"
+    Then I should see the following files
+       | app/models/message.rb          |
+     # | app/helpers/messages_helper.rb |
+       | db/migrate                     |
+	And I should see "class Message < ActiveRecord::Base" in file "app/models/message.rb"
+	And I should see "belongs_to :user" in file "app/models/message.rb"
+  
+ 	And I should see "def recievers" in file "app/models/message.rb"
+	And I should see "R.smembers(Message.receivers_for(self.id))" in file "app/models/message.rb"
+  	And I should see "end" in file "app/models/message.rb"
+	And I should see "def send_to(receivers_usernames)" in file "app/models/message.rb"
+    And I should see "receivers_usernames.each do |username|" in file "app/models/message.rb"
+	And I should see "R.sadd(Message.inbox_for(username), self.id)" in file "app/models/message.rb"
+    And I should see "R.sadd(Message.receivers_for(self.id), username)" in file "app/models/message.rb"
+	And I should see "end" in file "app/models/message.rb"
+	And I should see "end" in file "app/models/message.rb"
+  
+  	And I should see "def self.inbox_for(username)" in file "app/models/message.rb"
+  	And I should see "("message:#{username}:inbox")" in file "app/models/message.rb"
+  	And I should see "end" in file "app/models/message.rb"
+  
+  	And I should see "def self.receivers_for(message_id)" in file "app/models/message.rb"
+  	And I should see "("message:#{message_id}:receivers")" in file "app/models/message.rb"
+  	And I should see "end" in file "app/models/message.rb"
+  	And I should see "end" in file "app/models/message.rb"
+	
+	And I should see the following files
+		|app/models/user.rb|
+	And I should see "class User < ActiveRecord::Base" in file "app/models/user.rb"
+	And I should see "has_many :messages" in file "app/models/user.rb"
+	And I should see "def inbox" in file "app/models/user.rb"
+	And I should see "message_ids = R.smembers(Message.inbox_for(self.username))" in file "app/models/user.rb"
+	And I should see "Message.where(:visible => true, :id => message_ids).order("created_at DESC")" in file "app/models/user.rb"
+	And I should see "end" in file "app/models/user.rb"
+	And I should see "def outbox" in file "app/models/user.rb"
+	And I should see "self.messages(:visible => true)" in file "app/models/user.rb"
+	And I should see "end" in file "app/models/user.rb"
+	And I should see "end" in file "app/models/user.rb"
+	And I should not see file "temp_file.rb"
+

data/features/redis_messages_user_injection.feature

@@ -0,0 +1,36 @@
+Feature: Redis Messages Generator With Existing User Model
+  In order to send letters to multiple users
+  As a rails developer
+  I want to inject the messaging code into the existing User model
+
+
+  Scenario: Generate injected code into existing User Model
+    Given a new Rails app
+	When I run "rails g model user players username:string"
+    When I run "rails g redis_messages letters players Red"
+    Then I should see the following files
+       | app/models/letter.rb          |
+     # | app/helpers/messages_helper.rb |
+       | db/migrate                     |
+	And I should see "class Letter < ActiveRecord::Base" in file "app/models/letter.rb"
+	And I should see "belongs_to :player" in file "app/models/letter.rb"
+  
+	And I should see "Red.smembers(Letter.receivers_for(self.id))" in file "app/models/letter.rb"
+	And I should see "Red.sadd(Letter.inbox_for(username), self.id)" in file "app/models/letter.rb"
+    And I should see "Red.sadd(Letter.receivers_for(self.id), username)" in file "app/models/letter.rb"
+  
+  	And I should see "def self.inbox_for(username)" in file "app/models/letter.rb"
+  	And I should see "("letter:#{username}:inbox")" in file "app/models/letter.rb"
+  
+  	And I should see "def self.receivers_for(letter_id)" in file "app/models/letter.rb"
+  	And I should see "("letter:#{letter_id}:receivers")" in file "app/models/letter.rb"
+	
+	And I should see the following files
+		|app/models/player.rb|
+	And I should see "class Player < ActiveRecord::Base" in file "app/models/player.rb"
+	And I should see "has_many :letters" in file "app/models/player.rb"
+	And I should see "letter_ids = Red.smembers(Letter.inbox_for(self.username))" in file "app/models/player.rb"
+	And I should see "Letter.where(:visible => true, :id => letter_ids).order("created_at DESC")" in file "app/models/player.rb"
+
+	And I should see "self.letters(:visible => true)" in file "app/models/player.rb"
+	And I should not see file "temp_file.rb"

data/features/step_definitions/common_steps.rb

@@ -0,0 +1,47 @@
+When /^I run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end
+
+When /^I add "([^\"]*)" to file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.open(path, 'a') { |f| f.write(content + "\n") }
+end
+
+When /^I replace "([^\"]*)" with "([^\"]*)" in file "([^\"]*)"$/ do |old_content, new_content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  content = File.read(path).gsub(old_content, new_content)
+  File.open(path, 'w') { |f| f.write(content) }
+end
+
+Then /^I should see file "([^\"]*)"$/ do |path|
+  File.should exist(File.join(@current_directory, path))
+end
+
+Then /^I should not see file "([^\"]*)"$/ do |path|
+  File.should_not exist(File.join(@current_directory, path))
+end
+Then /^I should see "(.*)" in file "([^\"]*)"$/ do |content, short_path|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  File.readlines(path).join.should include(content)
+end
+
+Then /^I should see the following files$/ do |table|
+  table.raw.flatten.each do |path|
+    File.should exist(File.join(@current_directory, path))
+  end
+end
+
+Then /^I should see the following in file "([^\"]*)"$/ do |short_path, table|
+  path = File.join(@current_directory, short_path)
+  File.should exist(path)
+  table.raw.flatten.each do |content|
+    File.readlines(path).join.should include(content)
+  end
+end
+
+Then /^I should successfully run "([^\"]*)"$/ do |command|
+  system("cd #{@current_directory} && #{command}").should be_true
+end

data/features/step_definitions/rails_setup_steps.rb

@@ -0,0 +1,6 @@
+Given /^a new Rails app$/ do
+  FileUtils.mkdir_p("tmp")
+  system("rails new tmp/rails_app").should be_true
+  system("ln -s ../../../lib/generators tmp/rails_app/lib/generators").should be_true
+  @current_directory = File.expand_path("tmp/rails_app")
+end

data/features/support/env.rb

@@ -0,0 +1,6 @@
+require 'cucumber'
+require 'rspec'
+
+Before do
+  FileUtils.rm_rf "tmp/rails_app"
+end

data/features/support/matchers.rb

@@ -0,0 +1,7 @@
+RSpec::Matchers.define :exist do |path|
+  match do
+    File.exist?(path)
+  end
+  failure_message_for_should { "Expected #{path} to exist but no file found" }
+  failure_message_for_should_not { "Expected #{path} to not exist but file was found" }
+end

data/lib/generators/redis_messages/USAGE

@@ -0,0 +1,50 @@
+Description:
+    Generates a user model, users controller, and sessions controller. The
+    users controller handles the registration and the sessions controller
+    handles authentication. This is similar to restful_authentication, but
+    simpler.
+
+    IMPORTANT: This generator uses the "title" helper method which is generated
+    by the nifty_layout generator. You may want to run that generator first.
+
+Usage:
+    If you do not pass any arguments, the model name will default to "user", and
+    the authentication controller will default to "session". You can override
+    each of these respectively by passing one or two arguments. Either name can
+    be CamelCased or under_scored.
+
+    Make sure to setup the authlogic gem if you are using that option.
+
+      gem "authlogic" # in Gemfile
+
+Examples:
+    rails generate nifty:authentication
+
+        Creates user model, users_controller, and sessions_controller.
+
+    rails generate nifty:authentication account
+
+        Creates account model, accounts_controller, and sessions_controller.
+
+    rails generate nifty:authentication Account UserSession
+
+        Creates account model, accounts_controller, and user_sessions_controller.
+
+Methods:
+    There are several methods generated which you can use in your application.
+    Here's a common example of what you might add to your layout.
+
+      <% if logged_in? %>
+        Welcome <%= current_user.username %>! Not you?
+        <%= link_to "Log out", logout_path %>
+      <% else %>
+        <%= link_to "Sign up", signup_path %> or
+        <%= link_to "log in", login_path %>.
+      <% end %>
+
+    You can also restrict unregistered users from accessing a controller using
+    a before filter. For example.
+
+      before_filter :login_required, :except => [:index, :show]
+
+    See the generated file lib/authentication.rb for details.

data/lib/generators/redis_messages/redis_messages_generator.rb

@@ -0,0 +1,91 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+class RedisMessagesGenerator < Rails::Generators::Base #:nodoc:
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+      
+      argument :message_name, :type => :string, :default => 'message', :banner => 'message_name'
+      argument :user_name, :type => :string, :default => 'user', :banner => 'user_name'
+      argument :redis_constant_name, :type => :string, :default => "R", :banner => "redis_constant_name"
+
+
+      def create_model_files
+        if File.exist?(File.join(Dir.pwd, "app", "models", "#{user_singular_name}.rb"))
+          template('user_injection_code.rb', "temp_file.rb") #I need to READ this with the erb in it
+          code = IO.read(File.join(Dir.pwd,"temp_file.rb"))
+          inject_into_class(File.join(Dir.pwd, "app", "models", "#{user_singular_name}.rb"), user_class_name, code)
+          File.delete(File.join(Dir.pwd,"temp_file.rb"))
+        else
+          template 'user.rb', "app/models/#{user_singular_name}.rb"
+      end
+        template 'message.rb', "app/models/#{message_singular_name}.rb"
+      end
+      
+      def create_migration
+        migration_template 'message_migration.rb', "db/migrate/create_#{message_plural_name}.rb"
+        migration_template 'user_migration.rb', "db/migrate/create_#{user_plural_name}.rb" if File.exist?(File.join(Dir.pwd, "app", "models", "#{user_singular_name}.rb"))
+      end
+
+      def add_gems_and_initializer
+        unless File.read(destination_path("Gemfile")).include? "redis"
+          gem "redis" 
+          template"redis.rb", "config/initializers/redis.rb"
+        end
+      end
+            
+      private
+      def message_singular_name
+        message_name.underscore.singularize
+      end
+      
+      def message_plural_name
+        message_singular_name.pluralize
+      end
+      
+      def message_class_name
+        message_name.singularize.camelize
+      end
+      
+      def message_plural_class_name
+        message_plural_name.camelize
+      end
+            
+      def user_singular_name
+        user_name.underscore.singularize
+      end
+      
+      def user_plural_name
+        user_singular_name.pluralize
+      end
+      
+      def user_class_name
+        user_name.singularize.camelize
+      end
+      
+      def user_plural_class_name
+        user_plural_name.camelize
+      end
+      
+      def destination_path(path)
+        File.join(destination_root, path)
+      end
+      
+      # FIXME: Should be proxied to ActiveRecord::Generators::Base
+      # Implement the required interface for Rails::Generators::Migration.
+      
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+
+      # 
+      # def self.banner
+      #   "#{$0} seivan:#{generator_name} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]"
+      # end
+
+end

data/lib/generators/redis_messages/templates/message.rb

@@ -0,0 +1,23 @@
+class <%= message_class_name %> < ActiveRecord::Base
+  belongs_to :<%= user_singular_name %>
+  
+  def recievers
+    <%= redis_constant_name %>.smembers(<%= message_class_name %>.receivers_for(self.id))
+  end
+
+  #You want to do this in a background job, may I recommend resque. 
+  def send_to(receivers_usernames)
+    receivers_usernames.each do |username|
+      <%= redis_constant_name %>.sadd(<%= message_class_name %>.inbox_for(username), self.id)
+      <%= redis_constant_name %>.sadd(<%= message_class_name %>.receivers_for(self.id), username)
+    end
+  end
+  
+  def self.inbox_for(username)
+    ("<%= message_singular_name %>:#{username}:inbox")
+  end
+  
+  def self.receivers_for(<%= message_singular_name %>_id)
+    ("<%= message_singular_name %>:#{<%= message_singular_name %>_id}:receivers")
+  end
+end

data/lib/generators/redis_messages/templates/message_migration.rb

@@ -0,0 +1,15 @@
+class Create<%= message_plural_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= message_plural_name %> do |t|
+      t.string :title
+      t.string :content
+      t.boolean :visible
+      t.integer :<%= user_singular_name %>_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :<%= message_plural_name %>
+  end
+end