redis-friendships 0.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+0.1 (January 25, 2010)
+Doing initial Redis friendship generator, will be a swift move to 1.0
+Tests are done, but need refactoring. Need to make banners/descriptions to the generators

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,51 @@
+== What is redis-friendship
+  A friendship library with a certain follower/following system utilizing the power of both Redis and SQL. Using SQL for the users and Redis for the followers and the followings. Redis uses sets of usernames for both your followers and followings. And can be used to retrieve more information about your e.g. followers from SQL with those unique usernames. 
+
+== Install
+
+  gem install redis-friendships
+
+== Rails 3
+
+To use redis-friendships with Rails 3 you will need to include it in your Gemfile.
+
+group :development do
+  gem "redis-friendships"
+end
+
+== Usage
+  * rails g redis_friendships  : Will name the models User and Friendship and the Redis constant to R
+  
+  * rails g redis_friendships fellowship user : Assuming the User model already exist, this will inject code into it and create a Fellowship model
+
+  * rails g redis_friendships fellowship hobbit Red : Creates the models Fellowship and Hobbit and name the Redis constant to Red
+
+  * And don't forget to run your migrations since we also utilize SQL here, the user model will be SQL - anything else would be stupid, right?
+
+== Code
+== READ
+Assuming we use standard naming the user model will have two lookup scopes
+The first two are
+  user.followers and user.followings
+Where we do a SQL lookup with the list of usernames from the SET to get a list of user objects
+
+If you don't want the user objects but just their (unique) usernames
+  Friendship.followings_for(username)
+  Friendship.followers_for(username)
+	
+== WRITE
+To follow someone you just need to call 
+	user.follow!(other_user)
+This will just push the username into a SET.
+It will also make that user a following to the other_user_
+other_user.followings.include? user
+
+To unfollow someone (or have someone unfollowed, just edit it to your hearts desire)
+	user.stop_following!(other_user)
+This will remove it from user's SET. There are no limits to what you can do.
+Will also remove the user as a following from other_user
+other_user.followings.include?(user) == false
+
+PS
+You can also alter the methods to auto follow new followers or have requests before being stalked
+DS

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_friendships_named.feature

@@ -0,0 +1,60 @@
+Feature: Redis Friendships Generator With Named Models
+  In order to send befriend people
+  As a rails developer
+  I want to generate a fellowship library using fellowship as a name and hobbits as users
+
+
+  Scenario: Generate named messages
+    Given a new Rails app
+    When I run "rails g redis_friendships fellowships hobbit Red"
+    Then I should see the following files
+       | app/models/fellowship.rb  |
+	And I should see "class Fellowship" in file "app/models/fellowship.rb"
+
+	And I should see "def self.follow!(username, followed_username)" in file "app/models/fellowship.rb"
+	And I should see "Red.sadd("fellowship:#{username}:followings", followed_username)" in file "app/models/fellowship.rb"
+	And I should see "Red.sadd("fellowship:#{followed_username}:followings", username)" in file "app/models/fellowship.rb"
+
+    And I should see "def self.stop_following!(username, followed_username)" in file "app/models/fellowship.rb"
+    And I should see "Red.srem("fellowship:#{username}:followings", followed_username)" in file "app/models/fellowship.rb"
+    And I should see "Red.srem("fellowship:#{followed_username}:followings", username)" in file "app/models/fellowship.rb"
+
+	And I should see "def self.follows?(username, followed_username)" in file "app/models/fellowship.rb"
+    And I should see "Red.sismember("fellowship:#{username}:followings", followed_username)" in file "app/models/fellowship.rb"
+
+  	And I should see "def self.followed_by?(user, following_user)" in file "app/models/fellowship.rb"
+  	And I should see "Red.sismember("fellowship:#{username}:followers", following_username)" in file "app/models/fellowship.rb"    
+
+	And I should see "def self.followings_for(username)" in file "app/models/fellowship.rb"
+  	And I should see "Red.smembers("fellowship:#{username}:followings")" in file "app/models/fellowship.rb"
+
+  	And I should see "def self.followers_for(username)" in file "app/models/fellowship.rb" 
+  	And I should see "Red.smembers("fellowship:#{username}:followers")" in file "app/models/fellowship.rb"
+
+	And I should see the following files
+		|app/models/hobbit.rb|
+	And I should see "class Hobbit < ActiveRecord::Base" in file "app/models/hobbit.rb"
+
+  	And I should see "def followed_by?(user)" in file "app/models/hobbit.rb"
+  	And I should see "Fellowship.followed_by?(self.username, user.username)" in file "app/models/hobbit.rb"
+
+  	And I should see "def follows?(user)" in file "app/models/hobbit.rb"
+  	And I should see "Fellowship.follows?(self.username, user.username)" in file "app/models/hobbit.rb"
+ 
+  	And I should see "def follow!(user)" in file "app/models/hobbit.rb"
+ 	And I should see "return false if self.username == user.username" in file "app/models/hobbit.rb"
+	And I should see "Fellowship.follow!(self.username, user.username)" in file "app/models/hobbit.rb"
+	And I should see "true" in file "app/models/hobbit.rb"
+  
+	And I should see "def stop_following!(user)" in file "app/models/hobbit.rb"
+	And I should see "Fellowship.stop_following!(self.username, user.username)" in file "app/models/hobbit.rb"
+  
+	And I should see "def followers" in file "app/models/hobbit.rb"
+	And I should see "followers = Fellowship.followers_for(self.username)" in file "app/models/hobbit.rb"
+	And I should see "Hobbit.where(:username => followers)" in file "app/models/hobbit.rb"
+
+	And I should see "def followings" in file "app/models/hobbit.rb"
+	And I should see "followings = Fellowship.followings_for(self.username)" in file "app/models/hobbit.rb"
+	And I should see "Hobbit.where(:username => followings)" in file "app/models/hobbit.rb"
+	And I should not see file "temp_file.rb"
+

data/features/redis_friendships_standard.feature

@@ -0,0 +1,59 @@
+Feature: Redis Friendship Generator
+  In order to befriend multiple users
+  As a rails developer
+  I want to generate a Friendship library
+
+  Scenario: Generate default Friendship
+    Given a new Rails app
+    When I run "rails g redis_friendships"
+    Then I should see the following files
+       | app/models/friendship.rb  |
+	And I should see "class Friendship" in file "app/models/friendship.rb"
+
+	And I should see "def self.follow!(username, followed_username)" in file "app/models/friendship.rb"
+	And I should see "R.sadd("friendship:#{username}:followings", followed_username)" in file "app/models/friendship.rb"
+	And I should see "R.sadd("friendship:#{followed_username}:followings", username)" in file "app/models/friendship.rb"
+
+    And I should see "def self.stop_following!(username, followed_username)" in file "app/models/friendship.rb"
+    And I should see "R.srem("friendship:#{username}:followings", followed_username)" in file "app/models/friendship.rb"
+    And I should see "R.srem("friendship:#{followed_username}:followings", username)" in file "app/models/friendship.rb"
+
+	And I should see "def self.follows?(username, followed_username)" in file "app/models/friendship.rb"
+    And I should see "R.sismember("friendship:#{username}:followings", followed_username)" in file "app/models/friendship.rb"
+
+  	And I should see "def self.followed_by?(user, following_user)" in file "app/models/friendship.rb"
+  	And I should see "  R.sismember("friendship:#{username}:followers", following_username)" in file "app/models/friendship.rb"    
+
+	And I should see "def self.followings_for(username)" in file "app/models/friendship.rb"
+  	And I should see "R.smembers("friendship:#{username}:followings")" in file "app/models/friendship.rb"
+
+  	And I should see "def self.followers_for(username)" in file "app/models/friendship.rb" 
+  	And I should see "R.smembers("friendship:#{username}:followers")" in file "app/models/friendship.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 "def followed_by?(user)" in file "app/models/user.rb"
+  	And I should see "Friendship.followed_by?(self.username, user.username)" in file "app/models/user.rb"
+
+  	And I should see "def follows?(user)" in file "app/models/user.rb"
+  	And I should see "Friendship.follows?(self.username, user.username)" in file "app/models/user.rb"
+ 
+  	And I should see "def follow!(user)" in file "app/models/user.rb"
+ 	And I should see "return false if self.username == user.username" in file "app/models/user.rb"
+	And I should see "Friendship.follow!(self.username, user.username)" in file "app/models/user.rb"
+	And I should see "true" in file "app/models/user.rb"
+  
+	And I should see "def stop_following!(user)" in file "app/models/user.rb"
+	And I should see "Friendship.stop_following!(self.username, user.username)" in file "app/models/user.rb"
+  
+	And I should see "def followers" in file "app/models/user.rb"
+	And I should see "followers = Friendship.followers_for(self.username)" in file "app/models/user.rb"
+	And I should see "User.where(:username => followers)" in file "app/models/user.rb"
+
+	And I should see "def followings" in file "app/models/user.rb"
+	And I should see "followings = Friendship.followings_for(self.username)" in file "app/models/user.rb"
+	And I should see "User.where(:username => followings)" in file "app/models/user.rb"
+	And I should not see file "temp_file.rb"
+

data/features/redis_friendships_user_injection.feature

@@ -0,0 +1,37 @@
+Feature: Redis Messages Generator With Existing User Model
+  In order to blablablab this makes testing boring I need to refactor this anyway and I have a cold
+  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 hobbit username:string"
+    When I run "rails g redis_friendships fellowships hobbit Red"
+	And I should see the following files
+		|app/models/hobbit.rb|
+	And I should see "class Hobbit < ActiveRecord::Base" in file "app/models/hobbit.rb"
+
+  	And I should see "def followed_by?(user)" in file "app/models/hobbit.rb"
+  	And I should see "Fellowship.followed_by?(self.username, user.username)" in file "app/models/hobbit.rb"
+
+  	And I should see "def follows?(user)" in file "app/models/hobbit.rb"
+  	And I should see "Fellowship.follows?(self.username, user.username)" in file "app/models/hobbit.rb"
+ 
+  	And I should see "def follow!(user)" in file "app/models/hobbit.rb"
+ 	And I should see "return false if self.username == user.username" in file "app/models/hobbit.rb"
+	And I should see "Fellowship.follow!(self.username, user.username)" in file "app/models/hobbit.rb"
+	And I should see "true" in file "app/models/hobbit.rb"
+  
+	And I should see "def stop_following!(user)" in file "app/models/hobbit.rb"
+	And I should see "Fellowship.stop_following!(self.username, user.username)" in file "app/models/hobbit.rb"
+  
+	And I should see "def followers" in file "app/models/hobbit.rb"
+	And I should see "followers = Fellowship.followers_for(self.username)" in file "app/models/hobbit.rb"
+	And I should see "Hobbit.where(:username => followers)" in file "app/models/hobbit.rb"
+
+	And I should see "def followings" in file "app/models/hobbit.rb"
+	And I should see "followings = Fellowship.followings_for(self.username)" in file "app/models/hobbit.rb"
+	And I should see "Hobbit.where(:username => followings)" in file "app/models/hobbit.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_friendships/USAGE

@@ -0,0 +1,53 @@
+Have to edit this....
+
+== What is redis-friendship
+  A friendship library with a certain follower/following system utilizing the power of both Redis and SQL. Using SQL for the users and Redis for the followers and the followings. Redis uses sets of usernames for both your followers and followings. And can be used to retrieve more information about your e.g. followers from SQL with those unique usernames. 
+
+== Install
+
+  gem install redis-friendships
+
+== Rails 3
+
+To use redis-friendships with Rails 3 you will need to include it in your Gemfile.
+
+group :development do
+  gem "redis-friendships"
+end
+
+== Usage
+  * rails g redis_friendships  : Will name the models User and Friendship and the Redis constant to R
+  
+  * rails g redis_friendships fellowship user : Assuming the User model already exist, this will inject code into it and create a Fellowship model
+
+  * rails g redis_friendships fellowship hobbit Red : Creates the models Fellowship and Hobbit and name the Redis constant to Red
+
+  * And don't forget to run your migrations since we also utilize SQL here, the user model will be SQL - anything else would be stupid, right?
+
+== Code
+== READ
+Assuming we use standard naming the user model will have two lookup scopes
+The first two are
+  user.followers and user.followings
+Where we do a SQL lookup with the list of usernames from the SET to get a list of user objects
+
+If you don't want the user objects but just their (unique) usernames
+  Friendship.followings_for(username)
+  Friendship.followers_for(username)
+	
+== WRITE
+To follow someone you just need to call 
+	user.follow!(other_user)
+This will just push the username into a SET.
+It will also make that user a following to the other_user_
+other_user.followings.include? user
+
+To unfollow someone (or have someone unfollowed, just edit it to your hearts desire)
+	user.stop_following!(other_user)
+This will remove it from user's SET. There are no limits to what you can do.
+Will also remove the user as a following from other_user
+other_user.followings.include?(user) == false
+
+PS
+You can also alter the methods to auto follow new followers or have requests before being stalked
+DS

data/lib/generators/redis_friendships/redis_friendships_generator.rb

@@ -0,0 +1,90 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+
+class RedisFriendshipsGenerator < Rails::Generators::Base #:nodoc:
+    include Rails::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+      
+      argument :friendship_name, :type => :string, :default => 'friendship', :banner => 'friendship_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 'friendship.rb', "app/models/#{friendship_singular_name}.rb"
+      end
+      
+      def create_migration
+        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 friendship_singular_name
+        friendship_name.underscore.singularize
+      end
+      
+      def friendshipplural_name
+        friendship_singular_name.pluralize
+      end
+      
+      def friendship_class_name
+        friendship_name.singularize.camelize
+      end
+      
+      def friendship_plural_class_name
+        friendship_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