babylonia 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 073d7b1426c878adc6e781b9f92c312ffc839b24
+  data.tar.gz: 1a2e6c6ee29702aa1a4e2dce7cd9dc0532d1dd52
+SHA512:
+  metadata.gz: b100a52c1ec74ee94b59389474f0e41b5518d379f10df37344d244edceeda4cc7cda92f925ad8338d888a1bea7f59f4418bcf6bcc85393028feac458d38c9d22
+  data.tar.gz: 4698094b8e16d962b870b02b37c8b8fad5fba9d928a77456120bfe3d2d155a4415a60bdb5622136ca71daa5b524455f89eeeeebfbaa36452a4feef23e2ae1417

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/Gemfile

@@ -0,0 +1,12 @@
+source "http://rubygems.org"
+
+gemspec
+
+group :development do
+  gem "yard",       ">= 0.7.4"
+  gem "bundler",    ">= 1.0.0"
+end
+
+group :test do
+  gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,29 @@
+PATH
+  remote: .
+  specs:
+    babylonia (0.1.0)
+      i18n (>= 0.5.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    i18n (0.6.5)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.4)
+    yard (0.8.7.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  babylonia!
+  bundler (>= 1.0.0)
+  rspec
+  yard (>= 0.7.4)

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Beat
+
+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,4 @@
+babylonia
+=========
+
+User-side translation for ruby apps, persistence is yours

data/README.rdoc

@@ -0,0 +1,85 @@
+= babylonia {<img src="https://secure.travis-ci.org/beatrichartz/babylonia.png?branch=master" />}[http://travis-ci.org/beatrichartz/babylonia] {<img src="https://gemnasium.com/beatrichartz/babylonia.png" alt="Dependency Status" />}[https://gemnasium.com/beatrichartz/babylonia] {<img src="https://codeclimate.com/github/beatrichartz/babylonia.png" />}[https://codeclimate.com/github/beatrichartz/babylonia]
+Let there be languages for your users!
+
+== Installation
+In your gemfile
+  gem "babylonia"
+Or via the gem command
+  gem install babylonia
+
+== For Rails
+Try {babylonia-rails}[http://github.com/beatrichartz/babylonia-rails]
+
+== Why
+Out of the necessity to let users translate page content. This gem does not add columns or records to your tables, or tables to your database. It is implemented based on YAML and stores the given data in a string.
+
+== Persistence is all yours
+Persistence is all yours. There will be a string for you to store, and you should just make sure it can get stored. That means that depending on the count of languages you let your users handle, and on the length of strings you expect to put them in, you should have a look at the different BLOB types your storage offers. A mysql TEXT field can soon run out of space (it takes up to 21,844 characters), but a MEDIUMTEXT e.g. is pretty gigantic and should keep the crocodiles out of your sewers.
+
+== Gotchas
+Since the entire string will get stored in one field, you'll have to stop and ask yourself a question: Do you want to do database queries on the data in different languages? (like, let's say, sort by the translation users put in as an english translation for the field) If yes, it might be better for you to take a column based approach.
+
+== Basic Usage
+Let's assume a pretty basic class. Extend it with the Babylonian Class method
+  class Transsylvania
+    extend Babylonia::ClassMethods
+    attr_accessor :text
+    #now, build that tower
+    build_babylonian_tower_on :text
+  end
+  
+Now, do this:
+
+  t = Transsylvania.new
+  I18n.locale = :en
+  t.text = 'Pretty french, ist es nicht?'
+  I18n.locale = :de
+  t.text #=> nil
+  I18n.locale = :en
+  t.text #=> 'Pretty french, ist es nicht?'
+  
+Or this:
+
+  t.text = {en: 'This is english', fr: 'This is french'}
+  I18n.locale = :fr
+  t.text #=> :fr
+  
+== Extended Usage
+Let's once assume a pretty basic class. Extend it with the Babylonian Class method and add some options
+  class Transsylvania
+    attr_accessor :text, :name
+    
+    extend Babylonia::ClassMethods
+    
+    def some_locale
+      :it
+    end
+    
+    def locale
+      :en
+    end
+    
+    #now, build that tower
+    build_babylonian_tower_on :text, :name,
+                              locale: :some_locale, # will call the method some_locale on the instance
+                              default_locale: lambda {|instance, field| field == :text ? instance.locale : :de}, #will get evaluated at runtime
+                              fallback: false #=> will not fallback to default locale if no translation for locale is present
+                              placeholder: "<span class='translation missing'>Translation missing in Transsylvania</span>" a placeholder if no translation is present
+  end
+== Contributing to babylonia
+
+Please note that only open source APIs can be accepted as contributions to this gem. Private / Premium APIs have to be written as your own extension and will not be added to the gem code.
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Make sure to add documentation for it. This is important so everyone else can see what your code can do.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Beat Richartz. See LICENSE.txt for
+further details.

data/babylonia.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$LOAD_PATH << File.join(File.dirname(__FILE__), 'lib')
+require 'babylonia/version'
+
+Gem::Specification.new do |s|
+  s.name              = "babylonia"
+  s.version           = Babylonia::VERSION
+  s.authors           = ["Beat Richartz"]
+  s.description       = "Let your users translate their content into their languages without additional tables or columns in your tables"
+  s.email             = "attr_accessor@gmail.com"
+  s.licenses          = ["MIT"]
+  s.require_paths     = ["lib"]
+  s.summary           = "Let there be languages!"
+  
+  s.files             = `git ls-files`.split("\n")
+  s.test_files        = `git ls-files -- spec/*`.split("\n")
+  s.require_paths     = ["lib"]
+  
+  s.add_dependency              "i18n", ">= 0.5.0"
+  s.add_development_dependency  "bundler", ">= 1.0.0"
+end
+

data/lib/babylonia.rb

@@ -0,0 +1 @@
+require "babylonia/class_methods"

data/lib/babylonia/class_methods.rb

@@ -0,0 +1,63 @@
+require 'yaml'
+require 'i18n'
+
+module Babylonia
+  module ClassMethods
+    def build_babylonian_tower_on(*fields)
+      babylonian_options = fields.last.is_a?(Hash) ? fields.pop : {}
+      babylonian_options[:locale]          ||= lambda { |r, f| I18n.locale }
+      babylonian_options[:default_locale]  ||= lambda { |r, f| I18n.default_locale }
+      babylonian_options[:fallback]        = true if babylonian_options[:fallback].nil?
+      
+      # loop through fields to define methods such as "name" and "description"
+      fields.each do |field|
+        instance_variable_set(:"@babylonian_options_for_#{field}", babylonian_options)
+        
+        define_method :"#{field}_translated" do |locale=nil|
+          field_hash    = send(:"#{field}_hash")
+          translation   = field_hash[locale || evaluate_babylonian_option!(:locale, field)]
+          translation   = field_hash[evaluate_babylonian_option!(:default_locale, field)] if (translation.nil? or translation.empty?) and evaluate_babylonian_option!(:fallback, field)
+          (translation.nil? or translation.empty?) ? evaluate_babylonian_option!(:placeholder, field) : translation
+        end
+        alias_method :"#{field}_raw", field
+        alias_method field, :"#{field}_translated"
+        
+        define_method :"#{field}_hash" do
+          field_content = send(:"#{field}_raw")
+          field_content.is_a?(String) ? YAML.load(field_content) : {}
+        end
+        
+        define_method :"#{field}_languages" do
+          send(:"#{field}_hash").keys
+        end
+        
+        define_method :"#{field}_translated=" do |data|
+          current_hash = send(:"#{field}_hash")
+          
+          if data.is_a?(String)
+            current_hash.merge! evaluate_babylonian_option!(:locale, field) => data
+          elsif data.is_a?(Hash)
+            current_hash.merge! data
+          end
+          
+          send(:"#{field}_raw=", YAML.dump(current_hash))
+        end
+        alias_method :"#{field}_raw=", :"#{field}="
+        alias_method :"#{field}=", :"#{field}_translated="
+      end
+      
+      define_method :evaluate_babylonian_option! do |option, field|
+        options = self.class.instance_variable_get :"@babylonian_options_for_#{field}"
+
+        o = options[option]
+        if o.is_a? Proc
+          o.call self, field
+        elsif o.is_a? Symbol
+          send o
+        else
+          o
+        end
+      end
+    end
+  end
+end

data/lib/babylonia/version.rb

@@ -0,0 +1,3 @@
+module Babylonia
+  VERSION = '0.0.1'
+end

data/spec/babylonia/class_methods_spec.rb

@@ -0,0 +1,243 @@
+require 'spec_helper'
+
+describe Babylonia::ClassMethods do
+  
+  class BabylonianFields
+    extend Babylonia::ClassMethods
+    
+    attr_accessor :marshes, :grasslands, :desert, :sky
+    
+    build_babylonian_tower_on :marshes
+    build_babylonian_tower_on :grasslands, locales: %i(pi de en), locale: :architects_tongue, default_locale: lambda {|r, f| r.builders_tongue || :en }
+    build_babylonian_tower_on :desert, :sky, fallback: false, placeholder: lambda {|r, field| "<span class='missing translation'>Translation missing for " + field.to_s + "</span>"}
+  
+    def architects_tongue
+      :pi
+    end
+    
+    def builders_tongue
+      nil
+    end
+  end
+  
+  context "without options" do
+    subject { BabylonianFields.new }
+    before(:each) do
+      I18n.stub locale: :en, default_locale: :de
+    end
+    
+    describe "#marshes" do
+      context "with no data" do
+        it "should return nil" do
+          subject.marshes.should be_nil
+        end
+      end
+      context "with some raw data" do
+        before(:each) do
+          subject.stub marshes_raw: "---\n:en: TRANSLATION\n:de: FALLBACK"
+        end
+        it "should return the data" do
+          subject.marshes.should == "TRANSLATION"
+        end
+        context "with a locale argument" do
+          it "should return the translation in that locale" do
+            subject.marshes(:de).should == 'FALLBACK'
+          end
+        end
+      end
+      context "with only fallback data" do
+        before(:each) do
+          subject.stub marshes_raw: "---\n:de: FALLBACK"
+        end
+        it "should return the fallback data" do
+          subject.marshes.should == "FALLBACK"
+        end
+        context "with a locale argument" do
+          it "should return the fallback" do
+            subject.marshes(:en).should == 'FALLBACK'
+          end
+        end
+      end
+      context "with data in neither the current nor the fallback language" do
+        before(:each) do
+          subject.stub marshes_raw: "---\n:it: NO_FALLBACK"
+        end
+        it "should return the fallback data" do
+          subject.marshes.should be_nil
+        end
+        context "with a locale argument" do
+          it "should return the fallback" do
+            subject.marshes(:en).should be_nil
+          end
+        end
+      end
+    end
+    describe "marshes=" do
+      context "with no existing data" do
+        context "with a string" do
+          it "should set the current locales data" do
+            subject.marshes = 'SOME ENGLISH'
+            subject.marshes_raw.should == "---\n:en: SOME ENGLISH\n"
+            subject.marshes.should == 'SOME ENGLISH'
+          end
+        end
+        context "with a hash" do
+          it "should merge that hash with the existing data, if any" do
+            subject.marshes = {en: 'SOME ENGLISH', de: 'SOME DEUTSCH'}
+            subject.marshes_raw.should == "---\n:en: SOME ENGLISH\n:de: SOME DEUTSCH\n"
+            subject.marshes.should == 'SOME ENGLISH'
+            subject.marshes(:de).should == 'SOME DEUTSCH'
+          end
+        end
+      end
+      context "with existing data" do
+        before(:each) do
+          subject.marshes_raw = "---\n:it: SOME ITALIAN"
+        end
+        context "with a string" do
+          it "should set the current locales data" do
+            subject.marshes = 'SOME ENGLISH'
+            subject.marshes_raw.should == "---\n:it: SOME ITALIAN\n:en: SOME ENGLISH\n"
+            subject.marshes.should == 'SOME ENGLISH'
+            subject.marshes(:it).should == 'SOME ITALIAN'
+          end
+        end
+        context "with a hash" do
+          it "should merge that hash with the existing data, if any" do
+            subject.marshes = {en: 'SOME ENGLISH', de: 'SOME DEUTSCH'}
+            subject.marshes_raw.should == "---\n:it: SOME ITALIAN\n:en: SOME ENGLISH\n:de: SOME DEUTSCH\n"
+            subject.marshes.should == 'SOME ENGLISH'
+            subject.marshes(:de).should == 'SOME DEUTSCH'
+            subject.marshes(:it).should == 'SOME ITALIAN'
+          end
+        end
+      end
+    end
+    describe "marshes_hash" do
+      before(:each) do
+        subject.marshes_raw = "---\n:it: SOME ITALIAN\n:en: SOME ENGLISH\n:de: SOME DEUTSCH\n"
+      end
+      it "should return the loaded hash of the field" do
+        subject.marshes_hash.should == {it: 'SOME ITALIAN', en: 'SOME ENGLISH', de: 'SOME DEUTSCH'}
+      end
+    end
+    describe "marshes_languages" do
+      before(:each) do
+        subject.marshes_raw = "---\n:it: SOME ITALIAN\n:en: SOME ENGLISH\n:de: SOME DEUTSCH\n"
+      end
+      it "should return the translated languages of the field" do
+        subject.marshes_languages.sort.should == %i(de en it)
+      end
+    end
+  end
+  
+  context "with options" do
+    subject { BabylonianFields.new }
+    before(:each) do
+      I18n.stub locale: :en, default_locale: :de
+    end
+    
+    describe "#grasslands" do
+      context "with no data" do
+        it "should return nil" do
+          subject.grasslands.should be_nil
+        end
+      end
+      context "with some raw data" do
+        before(:each) do
+          subject.stub grasslands_raw: "---\n:pi: TRANSLATION\n:de: FALLBACK"
+        end
+        it "should return the data" do
+          subject.grasslands.should == "TRANSLATION"
+        end
+        context "with a locale argument" do
+          it "should return the translation in that locale" do
+            subject.grasslands(:de).should == 'FALLBACK'
+          end
+        end
+      end
+      context "with only fallback data" do
+        before(:each) do
+          subject.stub grasslands_raw: "---\n:en: FALLBACK"
+        end
+        it "should return the fallback data" do
+          subject.grasslands.should == "FALLBACK"
+        end
+        context "with a locale argument" do
+          it "should return the fallback" do
+            subject.grasslands(:pi).should == 'FALLBACK'
+          end
+        end
+      end
+      context "with data in neither the current nor the fallback language" do
+        before(:each) do
+          subject.stub grasslands_raw: "---\n:it: NO_FALLBACK"
+        end
+        it "should return the fallback data" do
+          subject.grasslands.should be_nil
+        end
+        context "with a locale argument" do
+          it "should return the fallback" do
+            subject.grasslands(:en).should be_nil
+          end
+        end
+      end
+      context "with fallback data, but fallback disabled" do
+        before(:each) do
+          subject.stub desert_raw: "---\n:it: NO_FALLBACK"
+        end
+        it "should not return the fallback data and display the placeholder" do
+          subject.desert.should == "<span class='missing translation'>Translation missing for desert</span>"
+        end
+        context "with a locale argument" do
+          it "should not return the fallback and display the placeholder" do
+            subject.desert(:pi).should == "<span class='missing translation'>Translation missing for desert</span>"
+          end
+        end
+      end
+    end
+    describe "grasslands=" do
+      context "with no existing data" do
+        context "with a string" do
+          it "should set the current locales data" do
+            subject.grasslands = 'SOME PIRATE'
+            subject.grasslands_raw.should == "---\n:pi: SOME PIRATE\n"
+            subject.grasslands.should == 'SOME PIRATE'
+          end
+        end
+        context "with a hash" do
+          it "should merge that hash with the existing data, if any" do
+            subject.grasslands = {pi: 'SOME PIRATE', de: 'SOME DEUTSCH'}
+            subject.grasslands_raw.should == "---\n:pi: SOME PIRATE\n:de: SOME DEUTSCH\n"
+            subject.grasslands.should == 'SOME PIRATE'
+            subject.grasslands(:de).should == 'SOME DEUTSCH'
+          end
+        end
+      end
+      context "with existing data" do
+        before(:each) do
+          subject.grasslands_raw = "---\n:it: SOME ITALIAN"
+        end
+        context "with a string" do
+          it "should set the current locales data" do
+            subject.grasslands = 'SOME PIRATE'
+            subject.grasslands_raw.should == "---\n:it: SOME ITALIAN\n:pi: SOME PIRATE\n"
+            subject.grasslands.should == 'SOME PIRATE'
+            subject.grasslands(:it).should == 'SOME ITALIAN'
+          end
+        end
+        context "with a hash" do
+          it "should merge that hash with the existing data, if any" do
+            subject.grasslands = {pi: 'SOME PIRATE', de: 'SOME DEUTSCH'}
+            subject.grasslands_raw.should == "---\n:it: SOME ITALIAN\n:pi: SOME PIRATE\n:de: SOME DEUTSCH\n"
+            subject.grasslands.should == 'SOME PIRATE'
+            subject.grasslands(:de).should == 'SOME DEUTSCH'
+            subject.grasslands(:it).should == 'SOME ITALIAN'
+          end
+        end
+      end
+    end
+  end
+  
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# -*- encoding : utf-8 -*-
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :test)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'babylonia'
+
+module HelperMethods
+  
+end
+
+RSpec.configuration.include(HelperMethods)

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: babylonia
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Beat Richartz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: Let your users translate their content into their languages without additional
+  tables or columns in your tables
+email: attr_accessor@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- README.rdoc
+- babylonia.gemspec
+- lib/babylonia.rb
+- lib/babylonia/class_methods.rb
+- lib/babylonia/version.rb
+- spec/babylonia/class_methods_spec.rb
+- spec/spec_helper.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Let there be languages!
+test_files:
+- spec/babylonia/class_methods_spec.rb
+- spec/spec_helper.rb
+has_rdoc: