couchrest_localised_properties 0.1

data/.gitignore

@@ -0,0 +1,3 @@
+*.swp
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+
+source :rubygems
+gemspec
+

data/LICENSE

@@ -0,0 +1,16 @@
+Copyright (c) 2007 Samuel Lown
+
+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.rdoc

@@ -0,0 +1,61 @@
+= CouchRest Localised Properties
+
+Localise your CouchRest Model properties as if by magic!
+
+== Introduction
+
+Storing translations of data is always a difficult problem. 
+
+CouchRest Localised Properties works by overwriting the normal attribute getters and setters with special localised versions that will magically replace the attribute with a hash. For each locale supported by your application there will be a key in the hash to store the real value. This approach allows you to apply any typecasting to the value being read as if you were working in just one locale.
+
+While getting and setting values is quite considerably easier, you'll still need to write your view methods manually.
+
+== Basic Usage
+
+    class Article < CouchRest::Model::Base
+      localised_property :title, String
+      localised_property :content, String
+
+      property :published_at, DateTime
+    end
+
+    # set language to english and set title
+    I18n.default_locale = :en
+    I18n.locale = :en
+    @a = Article.new
+    @a.title = "Test Title"
+
+    # language changed to spanish:
+    I18n.locale = :es
+    # returns default text as no translation set
+    @a.title == "Test Title"  # true
+
+    # set the title for spanish
+    @a.title = "Título de prueba"
+
+    # Have a look at the raw data
+    @a['title'] == {
+      'en' => "Test Title",
+      'es' => "Título de prueba"
+    }
+
+== Updates
+
+=== v0.1 - 25th March 2011
+
+ - First release
+
+== Todos / Bugs
+
+ - Please let me know!
+
+== License
+
+Copyright (c) 2011 Samuel Lown <me (AT) samlown.com>
+
+This Plugin is released under the MIT license, as Rails itself. Please see the 
+attached LICENSE file for further details.
+
+This document and plugin should be considered a work in progress until further
+notice!
+

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake'
+require "rake/rdoctask"
+
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all specs"
+Rspec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ["--color"]
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+desc "Print specdocs"
+Rspec::Core::RakeTask.new(:doc) do |spec|
+  spec.rspec_opts = ["--format", "specdoc"]
+  spec.pattern = 'spec/*_spec.rb'
+end
+
+desc "Generate the rdoc"
+Rake::RDocTask.new do |rdoc|
+  files = ["README.rdoc", "LICENSE", "lib/**/*.rb"]
+  rdoc.rdoc_files.add(files)
+  rdoc.main = "README.rdoc"
+  rdoc.title = "CouchRest Localised Properties Extension"
+end
+
+desc "Run the rspec"
+task :default => :spec

data/VERSION

@@ -0,0 +1 @@
+0.1

data/couchrest_localised_properties.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{couchrest_localised_properties}
+  s.version = File.read(File.join(File.dirname(__FILE__), 'VERSION')).strip
+
+  s.required_rubygems_version = Gem::Requirement.new("> 1.3.5") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sam Lown"]
+  s.date = %q{2011-03-23}
+  s.description = %q{Add support to CouchRest Model for localised properties.}
+  s.email = %q{me@samlown.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.homepage = %q{https://github.com/samlown/couchrest_localised_properties}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Add support to CouchRest Model for localised properties.}
+  
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("couchrest_model", "~> 1.1.0.beta")
+  s.add_dependency("i18n", "> 0.3.0")
+  s.add_development_dependency(%q<rspec>, ">= 2.0.0")
+end
+

data/lib/couchrest_localised_properties.rb

@@ -0,0 +1,81 @@
+#
+# CouchRest Localised Properties
+#
+
+require 'couchrest_model'
+
+module CouchRest
+  module LocalisedProperties
+
+    extend ActiveSupport::Concern
+
+    def read_localised_attribute(property)
+      attr = (self[find_property!(property).to_s] || {})
+      attr[I18n.locale.to_s] || attr[I18n.default_locale.to_s]
+    end
+
+    def write_localised_attribute(property, value)
+      prop = find_property!(property)
+      key = prop.to_s
+      if value.is_a?(Hash) # from mass-asign
+        self[key] = value
+        self[key].each do |k,v|
+          self[key][k] = prop.cast(self, v)
+        end
+      else
+        self[key] ||= { }
+        self[key][I18n.locale.to_s] = prop.is_a?(String) ? value : prop.cast(self, value)
+      end
+    end
+
+    module ClassMethods
+
+      def localised_property(name, *options, &block)
+        # Create a normal property
+        p = property(name, *options, &block)
+        raise "Localised properties cannot be used with Hashes!" if p.type == Hash
+        # Override the normal methods with special accessors
+        create_localised_property_getter(p)
+        create_localised_property_setter(p)
+      end
+
+      protected
+
+      # defines the getter for the property (and optional aliases)
+      def create_localised_property_getter(property)
+        # meth = property.name
+        class_eval <<-EOS, __FILE__, __LINE__ + 1
+          def #{property.name}
+            read_localised_attribute('#{property.name}')
+          end
+        EOS
+        if ['boolean', TrueClass.to_s.downcase].include?(property.type.to_s.downcase)
+          class_eval <<-EOS, __FILE__, __LINE__
+            def #{property.name}?
+              value = read_localised_attribute('#{property.name}')
+              !(value.nil? || value == false)
+            end
+          EOS
+        end
+      end
+
+      # defines the setter for the property (and optional aliases)
+      def create_localised_property_setter(property)
+        property_name = property.name
+        class_eval <<-EOS
+          def #{property_name}=(value)
+            write_localised_attribute('#{property_name}', value)
+          end
+        EOS
+      end
+
+    end
+
+  end
+end
+
+# Add self to the CouchRest Model Base
+CouchRest::Model::Base.class_eval do
+  include CouchRest::LocalisedProperties
+end
+

data/spec/scenario/localise_properties_spec.rb

@@ -0,0 +1,84 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+class Article < CouchRest::Model::Base
+  use_database DB
+  localised_property :title, String
+  localised_property :content, String
+  localised_property :active, TrueClass
+  property :posted_at, DateTime
+  timestamps!
+end
+
+I18n.default_locale = :en
+
+describe "Basic Usage" do
+
+  before :each do
+    @a = Article.new
+  end
+
+  after :each do
+    @a.destroy
+  end
+
+  it "should be possible to set and receive basic attributes" do
+    @a.title = "This is a test title"
+    @a.content = "This is the body of the article."
+    @a.active = true
+    @a.posted_at = now = DateTime.current
+
+    @a.save
+
+    @a = Article.first
+    @a.title.should eql("This is a test title")
+    @a.active.should be_true
+    @a.posted_at.to_s.should eql(now.to_s)
+  end
+
+  it "should be possible to use default values" do
+    @a.title = "This is a test title"
+    @a.save
+    @a = Article.first
+    I18n.locale = :es
+    @a.title.should eql("This is a test title")
+  end
+
+  it "should be possible to set value for other language" do
+    I18n.locale = :en
+    @a.title = "This is a test title"
+    I18n.locale = :es
+    @a.title = "Una prueba en castellano de un título"
+    @a.save
+
+    @a = Article.first
+    @a.title.should eql("Una prueba en castellano de un título")
+    I18n.locale = :en
+    @a.title.should eql("This is a test title")
+  end
+
+  it "should allow mass-asignment" do
+    I18n.locale = :en
+
+    @a.attributes = {:title => "TITLE TEST", :content => 'The body', :posted_at => DateTime.current}
+
+    @a.title.should eql("TITLE TEST")
+    @a.save
+
+    @a = Article.first
+    I18n.locale = :es
+    @a.title.should eql("TITLE TEST")
+    @a.attributes = {:title => "PRUEBA DE TITULO"}
+    @a.save
+
+    @a = Article.first
+    @a.title.should eql('PRUEBA DE TITULO')
+    @a.content.should eql('The body')
+
+    I18n.locale = :en
+    @a.title.should eql('TITLE TEST')
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+
+# Spec preparations, copied from couchrest model
+
+require "bundler/setup"
+require "rubygems"
+require "rspec"
+
+require File.join(File.dirname(__FILE__), '..','lib','couchrest_localised_properties')
+# check the following file to see how to use the spec'd features.
+
+unless defined?(COUCHHOST)
+  COUCHHOST = "http://127.0.0.1:5984"
+  TESTDB    = 'couchrest-localised-test'
+  TEST_SERVER    = CouchRest.new COUCHHOST
+  TEST_SERVER.default_database = TESTDB
+  DB = TEST_SERVER.database(TESTDB)
+end
+
+class Basic < CouchRest::Model::Base
+  use_database TEST_SERVER.default_database
+end
+
+def reset_test_db!
+  DB.recreate! rescue nil 
+  DB
+end
+
+RSpec.configure do |config|
+  config.before(:all) { reset_test_db! }
+  config.after(:all) do
+    cr = TEST_SERVER
+    test_dbs = cr.databases.select { |db| db =~ /^#{TESTDB}/ }
+    test_dbs.each do |db|
+      cr.database(db).delete! rescue nil
+    end
+  end
+end

data/spec/unit/couchrest_localised_properties_spec.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+require File.expand_path('../../spec_helper', __FILE__)
+
+class BasicLP < CouchRest::Model::Base
+  use_database DB
+  localised_property :title, String
+  property :posted_at, DateTime
+end
+
+I18n.default_locale = :en
+
+describe "CouchRest LocalisedProperties" do
+
+  describe "instance" do
+
+    before :each do
+      @obj = BasicLP.new
+    end
+
+    describe "#read_localised_attribute" do
+      before :each do
+        @obj['title'] = { 'en' => "Sample Title", 'es' => "Título de muestra" }
+      end
+
+      it "should read title appropriately" do
+        I18n.locale = :en
+        @obj.read_localised_attribute('title').should eql("Sample Title")
+        I18n.locale = 'es'
+        @obj.read_localised_attribute('title').should eql("Título de muestra")
+      end
+
+      it "should use default locale if no match available" do
+        I18n.locale = :de
+        @obj.read_localised_attribute('title').should eql('Sample Title')
+      end
+
+      it "should not cause any problems if data not set" do
+        @obj['title'] = nil
+        lambda { @obj.read_localised_attribute('title') }.should_not raise_error
+      end
+    end
+
+    describe "#write_localised_attribute" do
+      it "should write basic property" do
+        I18n.locale = 'en'
+        @obj.write_localised_attribute('title', "Sample Title")
+        @obj['title']['en'].should eql("Sample Title")
+        I18n.locale = 'es'
+        @obj.write_localised_attribute('title', "Ejemplo de un título")
+        @obj['title']['es'].should eql("Ejemplo de un título")
+      end
+
+      it "should allow mass-assignment with Hash" do
+        @obj.write_localised_attribute('title', {'en' => "Sample Title"})
+        @obj['title']['en'].should eql('Sample Title')
+      end
+
+      describe "with casting" do
+        before :each do
+          @prop = mock('Property')
+          @prop.should_receive(:to_s).and_return('title')
+          @prop.should_receive(:cast).and_return('the title')
+          @obj.should_receive(:find_property!).and_return(@prop)
+        end
+        it "should perform type casting on normal write" do
+          @prop.should_receive(:is_a?).and_return(false)
+          I18n.locale = 'en'
+          @obj.write_localised_attribute('title', 'something')
+          @obj['title']['en'].should eql('the title')
+        end
+        it "should perform casting on each key when hash sent" do
+          @prop.should_receive(:cast).and_return('the title') # second time
+          @obj.write_localised_attribute('title', {'en' => 'title', 'es' => 'título'})
+        end
+      end
+    end
+
+  end
+
+  describe "class methods" do
+
+    describe ".localised_property" do
+      it "should be added to class" do
+        BasicLP.respond_to?(:localised_property).should be_true
+      end
+
+      it "should call property method" do
+        prop = mock('Property')
+        prop.should_receive(:type).and_return(String)
+        BasicLP.should_receive(:property).with(:body).and_return(prop)
+        BasicLP.should_receive(:create_localised_property_getter)
+        BasicLP.should_receive(:create_localised_property_setter)
+        BasicLP.localised_property :body
+      end
+
+      it "should fail if type provided is a Hash" do
+        lambda { BasicLP.localised_property(:body, Hash) }.should raise_error
+      end
+
+      it "should create getters and setters" do
+        BasicLP.localised_property :active, TrueClass
+        @obj = BasicLP.new
+        @obj.respond_to?(:active).should be_true
+        @obj.respond_to?(:active?).should be_true
+        @obj.respond_to?(:active=).should be_true
+      end
+
+      it "getters and setters should pass on requests" do
+        BasicLP.localised_property :content, String
+        @obj = BasicLP.new
+        @obj.should_receive(:read_localised_attribute).with('content')
+        @obj.content
+        @obj.should_receive(:write_localised_attribute).with('content', 'foo')
+        @obj.content = 'foo'
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification 
+name: couchrest_localised_properties
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Sam Lown
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-23 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: couchrest_model
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        - beta
+        version: 1.1.0.beta
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :development
+  version_requirements: *id003
+description: Add support to CouchRest Model for localised properties.
+email: me@samlown.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- couchrest_localised_properties.gemspec
+- lib/couchrest_localised_properties.rb
+- spec/scenario/localise_properties_spec.rb
+- spec/spec_helper.rb
+- spec/unit/couchrest_localised_properties_spec.rb
+has_rdoc: true
+homepage: https://github.com/samlown/couchrest_localised_properties
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Add support to CouchRest Model for localised properties.
+test_files: []
+