enough_fields 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in enough_fields.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,53 @@
+PATH
+  remote: .
+  specs:
+    enough_fields (0.0.1)
+      uniform_notifier (~> 1.0.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activesupport (3.0.3)
+    bson (1.1.2)
+    bson_ext (1.1.2)
+    builder (2.1.2)
+    diff-lcs (1.1.2)
+    i18n (0.4.2)
+    mongo (1.1.2)
+      bson (>= 1.1.1)
+    mongoid (2.0.0.beta.20)
+      activemodel (~> 3.0)
+      mongo (~> 1.1)
+      tzinfo (~> 0.3.22)
+      will_paginate (~> 3.0.pre)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    ruby-growl (3.0)
+    tzinfo (0.3.23)
+    uniform_notifier (1.0.0)
+    will_paginate (3.0.pre2)
+    xmpp4r (0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bson (= 1.1.2)
+  bson_ext (= 1.1.2)
+  bundler (>= 1.0.0)
+  enough_fields!
+  mongoid (= 2.0.0.beta.20)
+  rspec (~> 2.1.0)
+  ruby-growl
+  uniform_notifier (~> 1.0.0)
+  xmpp4r

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Huang (flyerhzm@gmail.com)
+
+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.

data/README.md

@@ -0,0 +1,67 @@
+EnoughFields
+============
+
+EnoughFields helps you to use specified fields for mongoid.
+
+Best practice is to use EnoughFields in development mode or custom mode (staging, profile, etc.).
+
+Usage
+-----
+
+EnoughFields won't do ANYTHING unless you tell it to explicitly. Append to <code>config/environments/development.rb</code> initializer with the following code:
+    config.after_initialize do
+      EnoughFields.enable = true
+      EnoughFields.alert = true
+      EnoughFields.enough_fields_logger = true
+      EnoughFields.console = true
+      EnoughFields.growl = true
+      EnoughFields.xmpp = { :account => 'enough_fields_account@jabber.org',
+                            :password => 'enough_fields_password_for_jabber',
+                            :receiver => 'your_account@jabber.org',
+                            :show_online_status => true }
+      EnoughFields.rails_logger = true
+      EnoughFields.disable_browser_cache = true
+    end
+
+The notifier of enough_fields is a wrap of "uniform_notifier":https://github.com/flyerhzm/uniform_notifier
+
+The code above will enable all six of the EnoughFields notification systems:
+* <code>EnoughFields.enable</code>: enable EnoughFields plugin/gem, otherwise do nothing
+* <code>EnoughFields.alert</code>: pop up a JavaScript alert in the browser
+* <code>EnoughFields.enough_fields_logger</code>: log to the EnoughFields log file (Rails.root/log/enough_fields.log)
+* <code>EnoughFields.rails_logger</code>: add warnings directly to the Rails log
+* <code>EnoughFields.console</code>: log warnings to your browser's console.log (Safari/Webkit browsers or Firefox w/Firebug installed)
+* <code>EnoughFields.growl</code>: pop up Growl warnings if your system has Growl installed. Requires a little bit of configuration
+* <code>EnoughFields.xmpp</code>: send XMPP/Jabber notifications to the receiver indicated. Note that the code will currently not handle the adding of contacts, so you will need to make both accounts indicated know each other manually before you will receive any notifications. If you restart the development server frequently, the 'coming online' sound for the enough_fields account may start to annoy - in this case set :show_online_status to false; you will still get notifications, but the enough_fields account won't announce it's online status anymore.
+* <code>EnoughFields.disable_browser_cache</code>: disable browser cache which usually causes unexpected problems
+
+Growl Support
+-------------
+
+To get Growl support up-and-running for EnoughFields, follow the steps below:
+* Install the ruby-growl gem: <code>gem install ruby-growl</code>
+* Open the Growl preference pane in Systems Preferences
+* Click the "Network" tab
+* Make sure both "Listen for incoming notifications" and "Allow remote application registration" are checked. *Note*: If you set a password, you will need to set <code>EnoughFields.growl_password = { :password => 'growl password' }</code> in the config file.
+* Restart Growl ("General" tab -> Stop Growl -> Start Growl)
+* Boot up your application. EnoughFields will automatically send a Growl notification when Growl is turned on. If you do not see it when your application loads, make sure it is enabled in your initializer and double-check the steps above.
+
+Ruby 1.9 issue
+--------------
+
+ruby-growl gem has an issue about md5 in ruby 1.9, if you use growl and ruby 1.9, check this gist http://gist.github.com/300184
+
+XMPP/Jabber Support
+-------------------
+
+To get XMPP support up-and-running for EnoughFields, follow the steps below:
+* Install the xmpp4r gem: <code>gem install xmpp4r</code>
+* Make both the enough_fields and the recipient account add each other as contacts.
+  This will require you to manually log into both accounts, add each other
+  as contact and confirm each others contact request.
+* Boot up your application. EnoughFields will automatically send an XMPP notification when XMPP is turned on.
+
+Important
+---------
+
+If you find enough_fields does not work for you, *please disable your browser's cache*.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/enough_fields.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/enough_fields/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "enough_fields"
+  s.version     = EnoughFields::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Richard Huang']
+  s.email       = ['flyerhzm@gmail.com']
+  s.homepage    = "http://rubygems.org/gems/enough_fields"
+  s.summary     = "help to use specified fields for mongoid"
+  s.description = "help to use specified fields for mongoid"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "enough_fields"
+
+  s.add_dependency "uniform_notifier", "~> 1.0.0"
+
+  s.add_development_dependency "ruby-growl"
+  s.add_development_dependency "xmpp4r"
+  s.add_development_dependency "bson", "1.1.2"
+  s.add_development_dependency "bson_ext", "1.1.2"
+  s.add_development_dependency "mongoid", "2.0.0.beta.20"
+  s.add_development_dependency "rspec", "~> 2.1.0"
+  s.add_development_dependency "bundler", ">= 1.0.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/enough_fields.rb

@@ -0,0 +1,114 @@
+require 'uniform_notifier'
+
+module EnoughFields
+  autoload :Rack, 'enough_fields/rack'
+  autoload :AttributeValue, 'enough_fields/attribute_value'
+  autoload :Notification, 'enough_fields/notification'
+  autoload :Attributes, 'enough_fields/attributes'
+  autoload :MonitSet, 'enough_fields/monit_set'
+
+  if defined? Rails::Railtie
+    class EnoughFieldsRailtie < Rails::Railtie
+      initializer "enough_fields.configure_rails_initialization" do |app|
+        app.middleware.use EnoughFields::Rack
+      end
+    end
+  end
+
+  class <<self
+    attr_accessor :disable_browser_cache
+    delegate :alert=, :console=, :growl=, :rails_logger=, :xmpp=, :to => UniformNotifier
+
+    def enable=(enable)
+      @enable = enable
+      if enable?
+        Mongoid::Cursor.class_eval do
+          alias_method :origin_each, :each
+
+          def each
+            if @cursor.count > 1
+              @cursor.each do |document|
+                attributes = Attributes.build(@klass, document)
+                yield Mongoid::Factory.build(@klass, attributes)
+              end
+            else
+              :origin_each
+            end
+          end
+        end
+
+        Mongoid::Factory.class_eval do
+          class <<self
+            def build(klass, attributes)
+              type = attributes["_type"]
+              type ? type.constantize.instantiate(attributes) : klass.instantiate(attributes)
+            end
+          end
+        end
+      end
+    end
+
+    def enable?
+      @enable == true
+    end
+
+    def enough_fields_logger=(active)
+      if active
+        enough_fields_log_file = File.open( 'log/enough_fields.log', 'a+' )
+        enough_fields_log_file.sync
+        UniformNotifier.customized_logger = enough_fields_log_file
+      end
+    end
+
+    def start_request
+      Thread.current[:monit_set] = MonitSet.new
+    end
+
+    def end_request
+      Thread.current[:monit_set] = nil
+    end
+
+    def notification?
+      current_monit_set.check_notifications
+      !notifications.empty?
+    end
+
+    def add_notification(call_stack, klass, fields)
+      notification = Notification.new(call_stack, klass, fields)
+      notifications << notification
+    end
+
+    def gather_inline_notifications
+      responses = []
+      for_each_active_notifier_with_notification do |notification|
+        responses << notification.notify_inline
+      end
+      responses.join( "\n" )
+    end
+
+    def perform_out_of_channel_notifications
+      for_each_active_notifier_with_notification do |notification|
+        notification.notify_out_of_channel
+      end
+    end
+
+    private
+      def current_monit_set
+        Thread.current[:monit_set]
+      end
+
+      def notifications
+        @notifications ||= []
+      end
+
+      def for_each_active_notifier_with_notification
+        UniformNotifier.active_notifiers.each do |notifier|
+          notifications.each do |notification|
+            notification.notifier = notifier
+            yield notification
+          end
+        end
+      end
+
+  end
+end

data/lib/enough_fields/attribute_value.rb

@@ -0,0 +1,27 @@
+module EnoughFields
+  class AttributeValue
+    attr_reader :klass, :field, :call_stack
+    attr_writer :call_stack
+
+    def initialize(value, klass, field, call_stack)
+      @value = value
+      @klass = klass
+      @field = field
+      @call_stack = call_stack
+    end
+
+    def to_value
+      @value
+    end
+
+    def eql?( other )
+    self.klass == other.klass &&
+    self.field == other.field &&
+    self.call_stack == other.call_stack
+    end
+
+    def hash
+      self.klass.hash + self.field.hash + self.call_stack.hash
+    end
+  end
+end

data/lib/enough_fields/attributes.rb

@@ -0,0 +1,36 @@
+module EnoughFields
+  class Attributes < ActiveSupport::HashWithIndifferentAccess
+    class <<self
+      attr_accessor :klass
+
+      def build(klass, attributes)
+        @klass = klass
+        self[attributes]
+      end
+
+      def [](attributes)
+        return super unless Thread.current[:monit_set]
+
+        hash = super
+        hash.each do |key, value|
+          next if key.is_a? Array
+          attribute_value = AttributeValue.new(value, @klass, key, caller.find_all { |c| c.index Rails.root })
+          hash[ key ] = attribute_value
+          Thread.current[:monit_set] << attribute_value
+        end
+        hash
+      end
+    end
+
+    def [](key)
+      return super unless Thread.current[:monit_set]
+
+      if super && super.is_a?(AttributeValue)
+        super.call_stack = nil
+        super.to_value
+      else
+        super
+      end
+    end
+  end
+end

data/lib/enough_fields/monit_set.rb

@@ -0,0 +1,20 @@
+require 'set'
+
+module EnoughFields
+  class MonitSet < Set
+
+    def check_notifications
+      results = {}
+      self.each do |attribute_value|
+        if attribute_value.call_stack
+          results[ [attribute_value.call_stack, attribute_value.klass] ] ||= []
+          results[ [attribute_value.call_stack, attribute_value.klass] ] << attribute_value.field
+        end
+      end
+      results.each do |call_stack_klass, fields|
+        call_stack, klass = *call_stack_klass
+        EnoughFields.add_notification(call_stack, klass, fields)
+      end
+    end
+  end
+end

data/lib/enough_fields/notification.rb

@@ -0,0 +1,23 @@
+module EnoughFields
+  class Notification
+    attr_accessor :notifier
+
+    def initialize(call_stack, klass, fields)
+      @call_stack = call_stack
+      @klass = klass
+      @fields = fields
+    end
+
+    def full_notice
+      "add .only(#{(@klass.fields.keys - @fields).inspect}) for\n#{@call_stack.join("\n")}"
+    end
+
+    def notify_inline
+      self.notifier.inline_notify( self.full_notice )
+    end
+
+    def notify_out_of_channel
+      self.notifier.out_of_channel_notify( self.full_notice )
+    end
+  end
+end

data/lib/enough_fields/rack.rb

@@ -0,0 +1,44 @@
+module EnoughFields
+  class Rack
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      return @app.call(env) unless EnoughFields.enable?
+
+      EnoughFields.start_request
+      status, headers, response = @app.call(env)
+      return [status, headers, response] if empty?(response)
+
+      if EnoughFields.notification?
+        if status == 200 and !response.body.frozen? and check_html?(headers, response)
+          response_body = response.body << EnoughFields.gather_inline_notifications
+          headers['Content-Length'] = response_body.length.to_s
+        end
+        EnoughFields.perform_out_of_channel_notifications
+      end
+      response_body ||= response.body
+      EnoughFields.end_request
+      no_browser_cache(headers) if EnoughFields.disable_browser_cache
+      [status, headers, [response_body]]
+    end
+
+    # fix issue if response's body is a Proc
+    def empty?(response)
+      # response may be ["Not Found"], ["Move Permanently"], etc.
+      (response.is_a?(Array) && response.size <= 1) ||
+      !response.body.is_a?(String) || response.body.empty?
+    end
+
+    def check_html?(headers, response)
+      headers['Content-Type'] and headers['Content-Type'].include? 'text/html' and response.body =~ %r{<html.*</html>}m
+    end
+
+    def no_browser_cache(headers)
+      headers["Cache-Control"] = "no-cache, no-store, max-age=0, must-revalidate"
+      headers["Pragma"] = "no-cache"
+      headers["Expires"] = "Wed, 09 Sep 2009 09:09:09 GMT"
+    end
+  end
+end

data/lib/enough_fields/version.rb

@@ -0,0 +1,3 @@
+module EnoughFields
+  VERSION = "0.0.1"
+end

data/spec/enough_fields/enough_fields_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+
+module Rails
+  def self.root
+    File.dirname(__FILE__)
+  end
+end
+
+describe EnoughFields do
+
+  before :all do
+    User.create(:login => 'flyerhzm', :email => 'flyerhzm@gmail.com', :first_name => 'richard', :last_name => 'huang')
+    User.create(:login => 'richard', :email => 'richard@gmail.com', :first_name => 'richard', :last_name => 'huang')
+    User.create(:login => 'test', :email => 'test@gmail.com', :first_name => 'test', :last_name => 'test')
+  end
+
+  it "should" do
+    EnoughFields.enable = true
+    EnoughFields.growl = true
+    EnoughFields.start_request
+    Thread.current[:monit_set] = EnoughFields::MonitSet.new
+    p User.all.collect(&:email)
+    # User.all.to_a
+    if EnoughFields.notification?
+      EnoughFields.perform_out_of_channel_notifications
+    end
+    EnoughFields.end_request
+  end
+end

data/spec/models/user.rb

@@ -0,0 +1,5 @@
+class User
+  include Mongoid::Document
+  field :login
+  field :email
+end

data/spec/spec_helper.rb

@@ -0,0 +1,27 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), "..", "lib"))
+
+MODELS = File.join(File.dirname(__FILE__), "models")
+$LOAD_PATH.unshift(MODELS)
+
+require "mongoid"
+require "enough_fields"
+require "rspec"
+
+Mongoid.configure do |config|
+  name = "mongoid_test"
+  host = "localhost"
+  config.master = Mongo::Connection.new.db(name)
+  config.logger = nil
+  # config.slaves = [
+    # Mongo::Connection.new(host, 27018, :slave_ok => true).db(name)
+  # ]
+end
+
+Dir[ File.join(MODELS, "*.rb") ].sort.each { |file| require File.basename(file) }
+
+Rspec.configure do |config|
+  config.after :suite do
+    Mongoid.master.collections.select {|c| c.name !~ /system/ }.each(&:drop)
+  end
+end

metadata

@@ -0,0 +1,211 @@
+--- !ruby/object:Gem::Specification 
+name: enough_fields
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-22 00:00:00 +08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uniform_notifier
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: ruby-growl
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: bson
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 1
+        - 0
+        version: 2.1.0
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id008
+description: help to use specified fields for mongoid
+email: 
+- flyerhzm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- enough_fields.gemspec
+- lib/enough_fields.rb
+- lib/enough_fields/attribute_value.rb
+- lib/enough_fields/attributes.rb
+- lib/enough_fields/monit_set.rb
+- lib/enough_fields/notification.rb
+- lib/enough_fields/rack.rb
+- lib/enough_fields/version.rb
+- spec/enough_fields/enough_fields_spec.rb
+- spec/models/user.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/enough_fields
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 23
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: enough_fields
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: help to use specified fields for mongoid
+test_files: []
+