activerecord_translatable 0.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (42) hide show
  1. data/MIT-LICENSE +20 -0
  2. data/README.rdoc +73 -0
  3. data/Rakefile +38 -0
  4. data/lib/activerecord_translatable.rb +9 -0
  5. data/lib/activerecord_translatable/extension.rb +86 -0
  6. data/spec/activerecord_translateable_spec.rb +81 -0
  7. data/spec/dummy/README.rdoc +261 -0
  8. data/spec/dummy/Rakefile +7 -0
  9. data/spec/dummy/app/assets/javascripts/application.js +15 -0
  10. data/spec/dummy/app/assets/stylesheets/application.css +13 -0
  11. data/spec/dummy/app/controllers/application_controller.rb +3 -0
  12. data/spec/dummy/app/helpers/application_helper.rb +2 -0
  13. data/spec/dummy/app/models/something.rb +5 -0
  14. data/spec/dummy/app/views/layouts/application.html.erb +14 -0
  15. data/spec/dummy/config.ru +4 -0
  16. data/spec/dummy/config/application.rb +65 -0
  17. data/spec/dummy/config/boot.rb +10 -0
  18. data/spec/dummy/config/database.yml +29 -0
  19. data/spec/dummy/config/environment.rb +5 -0
  20. data/spec/dummy/config/environments/development.rb +37 -0
  21. data/spec/dummy/config/environments/production.rb +67 -0
  22. data/spec/dummy/config/environments/test.rb +37 -0
  23. data/spec/dummy/config/initializers/backtrace_silencers.rb +7 -0
  24. data/spec/dummy/config/initializers/i18n_backend.rb +1 -0
  25. data/spec/dummy/config/initializers/inflections.rb +15 -0
  26. data/spec/dummy/config/initializers/mime_types.rb +5 -0
  27. data/spec/dummy/config/initializers/secret_token.rb +7 -0
  28. data/spec/dummy/config/initializers/session_store.rb +8 -0
  29. data/spec/dummy/config/initializers/wrap_parameters.rb +14 -0
  30. data/spec/dummy/config/locales/en.yml +5 -0
  31. data/spec/dummy/config/routes.rb +58 -0
  32. data/spec/dummy/db/migrate/20121015083259_create_somethings.rb +8 -0
  33. data/spec/dummy/db/schema.rb +22 -0
  34. data/spec/dummy/log/development.log +96 -0
  35. data/spec/dummy/log/test.log +47 -0
  36. data/spec/dummy/public/404.html +26 -0
  37. data/spec/dummy/public/422.html +26 -0
  38. data/spec/dummy/public/500.html +25 -0
  39. data/spec/dummy/public/favicon.ico +0 -0
  40. data/spec/dummy/script/rails +6 -0
  41. data/spec/spec_helper.rb +15 -0
  42. metadata +192 -0
@@ -0,0 +1,20 @@
1
+ Copyright 2012 Philipp Fehre <philipp.fehre@gmail.com>
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,73 @@
1
+ = ActiveRecordTranslatable
2
+
3
+ Make attributes of an ActiveRecord Model translatable, and store the
4
+ translations in the provided I18n backend. This is really helpful if there
5
+ already is, a interface to provide ie missing translations for elements in I18n.
6
+
7
+ == Usage
8
+
9
+ class MyModel < ActiveRecord::Base
10
+ include ActiveRecordTranslatable
11
+ translate :title
12
+ end
13
+
14
+ I18n.locale = :en
15
+ mymodel = MyModel.create(title: "My title", title_de: "Mein Title)
16
+ mymodel.title_wk = "Woohhaakkk"
17
+
18
+ mymodel.title # => "My title"
19
+ mymodel.title_en # => "My title"
20
+ mymodel.title_wk # => "Woohhaakkk"
21
+
22
+ == Prerequisites
23
+ To save the locales ActiveRecordTranslatable saves an array of the specified locale, for
24
+ this to work, the database needs the ability to save arrays. The easiest way to
25
+ handle this in postgres is via the postgres array
26
+
27
+ gem 'activerecord-postgres-array'
28
+
29
+ To add the array to the model the migration looks like this
30
+
31
+ class CreateMyModel < ActiveRecord::Migration
32
+ def change
33
+ create_table :my_model do |t|
34
+ t.string_array :locales
35
+ end
36
+ end
37
+ end
38
+
39
+ == How it works
40
+
41
+ Translateable saves the translation via I18n.backend.store_translations, this
42
+ means that the backend has to be able to store new items. So backend needs to
43
+ be for example the KeyValue or ActiveRecord one.
44
+ More http://railscasts.com/episodes/256-i18n-backends
45
+
46
+ == Miscellaneous
47
+
48
+ === Tests
49
+ The tests are using rspec, and there is a dummy app setup in the spec directory.
50
+ Since the example is using postgres, to get the tests working there needs to be
51
+ a setup postgres user with the needed rights.
52
+
53
+ $ createuser -h localhost
54
+ Enter name of role to add: translatable
55
+ Shall the new role be a superuser? (y/n) n
56
+ Shall the new role be allowed to create databases? (y/n) y
57
+ Shall the new role be allowed to create more new roles? (y/n) n
58
+
59
+ Afterwards the db needs to be setup
60
+
61
+ $ cd spec/dummy
62
+ $ rake db:create
63
+ $ rake db:migrate
64
+ $ rake db:test:prepare
65
+
66
+ Now the test can be run via
67
+
68
+ $ rspec
69
+
70
+ === Current State
71
+ The gem is still in early development and has just been extracted from a
72
+ project. So any bug reports and contributions are highly welcome.
73
+
@@ -0,0 +1,38 @@
1
+ #!/usr/bin/env rake
2
+ begin
3
+ require 'bundler/setup'
4
+ rescue LoadError
5
+ puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
6
+ end
7
+ begin
8
+ require 'rdoc/task'
9
+ require 'rspec/core/rake_task'
10
+ rescue LoadError
11
+ require 'rdoc/rdoc'
12
+ require 'rake/rdoctask'
13
+ RDoc::Task = Rake::RDocTask
14
+ end
15
+
16
+ RDoc::Task.new(:rdoc) do |rdoc|
17
+ rdoc.rdoc_dir = 'rdoc'
18
+ rdoc.title = 'Translatable'
19
+ rdoc.options << '--line-numbers'
20
+ rdoc.rdoc_files.include('README.rdoc')
21
+ rdoc.rdoc_files.include('lib/**/*.rb')
22
+ end
23
+
24
+ Bundler::GemHelper.install_tasks
25
+
26
+ desc 'Default: run the specs'
27
+ task :default => 'spec:unit'
28
+
29
+ namespace :spec do
30
+ desc "Run unit specs"
31
+ RSpec::Core::RakeTask.new('unit') do |t|
32
+ t.pattern = 'spec/{*_spec.rb}'
33
+ end
34
+ end
35
+
36
+ desc "Run the unit specs"
37
+ task :spec => ['spec:unit']
38
+
@@ -0,0 +1,9 @@
1
+ require "active_record"
2
+ require "active_support/concern"
3
+ require "activerecord_translatable/extension"
4
+
5
+ module ActiveRecordTranslatable
6
+
7
+ VERSION = "0.0.1"
8
+
9
+ end
@@ -0,0 +1,86 @@
1
+ module ActiveRecordTranslatable
2
+ extend ActiveSupport::Concern
3
+
4
+ attr_accessor :translations
5
+
6
+ def setup_locale(locale)
7
+ locales = self.locales || []
8
+ locales << locale.to_s
9
+ self.locales = locales.uniq
10
+ @translations ||= {}
11
+ @translations[locale] ||= {}
12
+ end
13
+
14
+ def available_locales
15
+ self.locales.map { |locale| locale.to_sym }
16
+ end
17
+
18
+ def translation(attribute, locale = I18n.locale)
19
+ setup_locale(locale)
20
+ begin
21
+ @translations[locale][attribute] ||= I18n.t("#{self.base_name}.#{attribute}-#{self.id}",
22
+ locale: locale, raise: true)
23
+ rescue I18n::MissingTranslationData
24
+ @translations[locale][attribute]
25
+ end
26
+ end
27
+
28
+ def set_translation(attribute, value, locale = I18n.locale)
29
+ setup_locale(locale)
30
+ @translations[locale][attribute] = value
31
+ end
32
+
33
+ def write_translations
34
+ @translations.each do |locale, translations|
35
+ translations.each do |attribute, value|
36
+ I18n.backend.store_translations(locale, { "#{self.base_name}.#{attribute}-#{self.id}" => value }, escape: false)
37
+ end
38
+ end
39
+ end
40
+
41
+ def method_missing(method_name, *arguments, &block)
42
+ self.translateable.each do |attribute|
43
+ attribute = attribute.to_s
44
+ if method_name.to_s =~ /^#{attribute}_(.{2})=$/
45
+ return set_translation(attribute, arguments.first, $1.to_sym)
46
+ elsif method_name.to_s =~ /^#{attribute}=$/
47
+ return set_translation(attribute, arguments.first)
48
+ elsif method_name.to_s =~ /^#{attribute}_(.{2})$/
49
+ return translation(attribute, $1.to_sym)
50
+ elsif method_name.to_s =~ /^#{attribute}$/
51
+ return translation(attribute)
52
+ end
53
+ end
54
+ super
55
+ end
56
+
57
+ def respond_to_missing?(method_name, include_private = false)
58
+ self.translateable.each do |attribute|
59
+ attribute = attribute.to_s
60
+ if method_name.to_s =~ /^#{attribute}_(.{2})=$/
61
+ return true
62
+ elsif method_name.to_s =~ /^#{attribute}=$/
63
+ return true
64
+ elsif method_name.to_s =~ /^#{attribute}_(.{2})$/
65
+ return true
66
+ elsif method_name.to_s =~ /^#{attribute}$/
67
+ return true
68
+ end
69
+ end
70
+ false
71
+ end
72
+
73
+ included do
74
+ after_save :write_translations
75
+ cattr_accessor :translateable, :base_name
76
+ end
77
+
78
+ module ClassMethods
79
+ def translate(*attributes)
80
+ self.base_name = self.name.downcase
81
+ self.translateable ||= []
82
+ self.translateable = self.translateable.concat(attributes)
83
+ end
84
+ end
85
+
86
+ end
@@ -0,0 +1,81 @@
1
+ require 'spec_helper'
2
+
3
+ describe "ActiveRecordTranslateable" do
4
+
5
+ it "should add name to translateable" do
6
+ Something.translateable.should include(:name)
7
+ end
8
+
9
+ context "translations" do
10
+ before(:each) do
11
+ @something = Something.create!(name: "Something")
12
+ @locale = I18n.locale
13
+ end
14
+
15
+ after(:each) do
16
+ I18n.locale = @locale
17
+ end
18
+
19
+ it "should get the translation from stored translations" do
20
+ @something.set_translation("name", "Etwas", :de)
21
+ @something.translations[:de]["name"].should == "Etwas"
22
+ end
23
+
24
+ it "should set the translation to the stored translations" do
25
+ @something.set_translation("name", "Etwas", :de)
26
+ @something.translation("name", :de).should == "Etwas"
27
+ end
28
+
29
+ it "should get the translation for the default I18n locale" do
30
+ I18n.locale = :de
31
+ @something.set_translation("name", "Etwas")
32
+ @something.translation("name").should == "Etwas"
33
+ end
34
+
35
+ it "should set the translation for the default I18n locale" do
36
+ I18n.locale = :de
37
+ @something.set_translation("name", "Etwas")
38
+ @something.translation("name", :de).should == "Etwas"
39
+ end
40
+
41
+ it "should write the stored translations to the backend" do
42
+ backend = double("Backend")
43
+ I18n.stub(:backend).and_return(backend)
44
+ backend.should_receive(:store_translations).
45
+ with(:en, { "something.name-#{@something.id}" => "Something" }, escape: false)
46
+ @something.write_translations
47
+ end
48
+
49
+ end
50
+
51
+ context "custom created methods" do
52
+ let(:something) { Something.create!(name: "Something") }
53
+
54
+ it "should respond to translated attributes" do
55
+ something.should respond_to(:name)
56
+ something.should respond_to(:name=)
57
+ something.should respond_to(:name_de)
58
+ something.should respond_to(:name_de=)
59
+ end
60
+
61
+ it "should get the translated attributes" do
62
+ something = Something.create!(name: "Something", name_de: "Etwas")
63
+ something_from_db = Something.find(something.id)
64
+ something_from_db.name.should == "Something"
65
+ something_from_db.name_de.should == "Etwas"
66
+ end
67
+
68
+ end
69
+
70
+ context "locales" do
71
+ let(:something) { Something.create!(name: "Something") }
72
+
73
+ it "should respond with available locales" do
74
+ something.available_locales.should include(:en)
75
+ something.name_de = "Etwas"
76
+ something.available_locales.should include(:en, :de)
77
+ end
78
+
79
+ end
80
+
81
+ end
@@ -0,0 +1,261 @@
1
+ == Welcome to Rails
2
+
3
+ Rails is a web-application framework that includes everything needed to create
4
+ database-backed web applications according to the Model-View-Control pattern.
5
+
6
+ This pattern splits the view (also called the presentation) into "dumb"
7
+ templates that are primarily responsible for inserting pre-built data in between
8
+ HTML tags. The model contains the "smart" domain objects (such as Account,
9
+ Product, Person, Post) that holds all the business logic and knows how to
10
+ persist themselves to a database. The controller handles the incoming requests
11
+ (such as Save New Account, Update Product, Show Post) by manipulating the model
12
+ and directing data to the view.
13
+
14
+ In Rails, the model is handled by what's called an object-relational mapping
15
+ layer entitled Active Record. This layer allows you to present the data from
16
+ database rows as objects and embellish these data objects with business logic
17
+ methods. You can read more about Active Record in
18
+ link:files/vendor/rails/activerecord/README.html.
19
+
20
+ The controller and view are handled by the Action Pack, which handles both
21
+ layers by its two parts: Action View and Action Controller. These two layers
22
+ are bundled in a single package due to their heavy interdependence. This is
23
+ unlike the relationship between the Active Record and Action Pack that is much
24
+ more separate. Each of these packages can be used independently outside of
25
+ Rails. You can read more about Action Pack in
26
+ link:files/vendor/rails/actionpack/README.html.
27
+
28
+
29
+ == Getting Started
30
+
31
+ 1. At the command prompt, create a new Rails application:
32
+ <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
33
+
34
+ 2. Change directory to <tt>myapp</tt> and start the web server:
35
+ <tt>cd myapp; rails server</tt> (run with --help for options)
36
+
37
+ 3. Go to http://localhost:3000/ and you'll see:
38
+ "Welcome aboard: You're riding Ruby on Rails!"
39
+
40
+ 4. Follow the guidelines to start developing your application. You can find
41
+ the following resources handy:
42
+
43
+ * The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
44
+ * Ruby on Rails Tutorial Book: http://www.railstutorial.org/
45
+
46
+
47
+ == Debugging Rails
48
+
49
+ Sometimes your application goes wrong. Fortunately there are a lot of tools that
50
+ will help you debug it and get it back on the rails.
51
+
52
+ First area to check is the application log files. Have "tail -f" commands
53
+ running on the server.log and development.log. Rails will automatically display
54
+ debugging and runtime information to these files. Debugging info will also be
55
+ shown in the browser on requests from 127.0.0.1.
56
+
57
+ You can also log your own messages directly into the log file from your code
58
+ using the Ruby logger class from inside your controllers. Example:
59
+
60
+ class WeblogController < ActionController::Base
61
+ def destroy
62
+ @weblog = Weblog.find(params[:id])
63
+ @weblog.destroy
64
+ logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
65
+ end
66
+ end
67
+
68
+ The result will be a message in your log file along the lines of:
69
+
70
+ Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
71
+
72
+ More information on how to use the logger is at http://www.ruby-doc.org/core/
73
+
74
+ Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
75
+ several books available online as well:
76
+
77
+ * Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
78
+ * Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
79
+
80
+ These two books will bring you up to speed on the Ruby language and also on
81
+ programming in general.
82
+
83
+
84
+ == Debugger
85
+
86
+ Debugger support is available through the debugger command when you start your
87
+ Mongrel or WEBrick server with --debugger. This means that you can break out of
88
+ execution at any point in the code, investigate and change the model, and then,
89
+ resume execution! You need to install ruby-debug to run the server in debugging
90
+ mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
91
+
92
+ class WeblogController < ActionController::Base
93
+ def index
94
+ @posts = Post.all
95
+ debugger
96
+ end
97
+ end
98
+
99
+ So the controller will accept the action, run the first line, then present you
100
+ with a IRB prompt in the server window. Here you can do things like:
101
+
102
+ >> @posts.inspect
103
+ => "[#<Post:0x14a6be8
104
+ @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
105
+ #<Post:0x14a6620
106
+ @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
107
+ >> @posts.first.title = "hello from a debugger"
108
+ => "hello from a debugger"
109
+
110
+ ...and even better, you can examine how your runtime objects actually work:
111
+
112
+ >> f = @posts.first
113
+ => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
114
+ >> f.
115
+ Display all 152 possibilities? (y or n)
116
+
117
+ Finally, when you're ready to resume execution, you can enter "cont".
118
+
119
+
120
+ == Console
121
+
122
+ The console is a Ruby shell, which allows you to interact with your
123
+ application's domain model. Here you'll have all parts of the application
124
+ configured, just like it is when the application is running. You can inspect
125
+ domain models, change values, and save to the database. Starting the script
126
+ without arguments will launch it in the development environment.
127
+
128
+ To start the console, run <tt>rails console</tt> from the application
129
+ directory.
130
+
131
+ Options:
132
+
133
+ * Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
134
+ made to the database.
135
+ * Passing an environment name as an argument will load the corresponding
136
+ environment. Example: <tt>rails console production</tt>.
137
+
138
+ To reload your controllers and models after launching the console run
139
+ <tt>reload!</tt>
140
+
141
+ More information about irb can be found at:
142
+ link:http://www.rubycentral.org/pickaxe/irb.html
143
+
144
+
145
+ == dbconsole
146
+
147
+ You can go to the command line of your database directly through <tt>rails
148
+ dbconsole</tt>. You would be connected to the database with the credentials
149
+ defined in database.yml. Starting the script without arguments will connect you
150
+ to the development database. Passing an argument will connect you to a different
151
+ database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
152
+ PostgreSQL and SQLite 3.
153
+
154
+ == Description of Contents
155
+
156
+ The default directory structure of a generated Ruby on Rails application:
157
+
158
+ |-- app
159
+ | |-- assets
160
+ | |-- images
161
+ | |-- javascripts
162
+ | `-- stylesheets
163
+ | |-- controllers
164
+ | |-- helpers
165
+ | |-- mailers
166
+ | |-- models
167
+ | `-- views
168
+ | `-- layouts
169
+ |-- config
170
+ | |-- environments
171
+ | |-- initializers
172
+ | `-- locales
173
+ |-- db
174
+ |-- doc
175
+ |-- lib
176
+ | `-- tasks
177
+ |-- log
178
+ |-- public
179
+ |-- script
180
+ |-- test
181
+ | |-- fixtures
182
+ | |-- functional
183
+ | |-- integration
184
+ | |-- performance
185
+ | `-- unit
186
+ |-- tmp
187
+ | |-- cache
188
+ | |-- pids
189
+ | |-- sessions
190
+ | `-- sockets
191
+ `-- vendor
192
+ |-- assets
193
+ `-- stylesheets
194
+ `-- plugins
195
+
196
+ app
197
+ Holds all the code that's specific to this particular application.
198
+
199
+ app/assets
200
+ Contains subdirectories for images, stylesheets, and JavaScript files.
201
+
202
+ app/controllers
203
+ Holds controllers that should be named like weblogs_controller.rb for
204
+ automated URL mapping. All controllers should descend from
205
+ ApplicationController which itself descends from ActionController::Base.
206
+
207
+ app/models
208
+ Holds models that should be named like post.rb. Models descend from
209
+ ActiveRecord::Base by default.
210
+
211
+ app/views
212
+ Holds the template files for the view that should be named like
213
+ weblogs/index.html.erb for the WeblogsController#index action. All views use
214
+ eRuby syntax by default.
215
+
216
+ app/views/layouts
217
+ Holds the template files for layouts to be used with views. This models the
218
+ common header/footer method of wrapping views. In your views, define a layout
219
+ using the <tt>layout :default</tt> and create a file named default.html.erb.
220
+ Inside default.html.erb, call <% yield %> to render the view using this
221
+ layout.
222
+
223
+ app/helpers
224
+ Holds view helpers that should be named like weblogs_helper.rb. These are
225
+ generated for you automatically when using generators for controllers.
226
+ Helpers can be used to wrap functionality for your views into methods.
227
+
228
+ config
229
+ Configuration files for the Rails environment, the routing map, the database,
230
+ and other dependencies.
231
+
232
+ db
233
+ Contains the database schema in schema.rb. db/migrate contains all the
234
+ sequence of Migrations for your schema.
235
+
236
+ doc
237
+ This directory is where your application documentation will be stored when
238
+ generated using <tt>rake doc:app</tt>
239
+
240
+ lib
241
+ Application specific libraries. Basically, any kind of custom code that
242
+ doesn't belong under controllers, models, or helpers. This directory is in
243
+ the load path.
244
+
245
+ public
246
+ The directory available for the web server. Also contains the dispatchers and the
247
+ default HTML files. This should be set as the DOCUMENT_ROOT of your web
248
+ server.
249
+
250
+ script
251
+ Helper scripts for automation and generation.
252
+
253
+ test
254
+ Unit and functional tests along with fixtures. When using the rails generate
255
+ command, template test files will be generated for you and placed in this
256
+ directory.
257
+
258
+ vendor
259
+ External libraries that the application depends on. Also includes the plugins
260
+ subdirectory. If the app has frozen rails, those gems also go here, under
261
+ vendor/rails/. This directory is in the load path.