i15r 0.4.4 → 0.5.0

data/spec/i15r_spec.rb

@@ -1,10 +1,11 @@
 # encoding: UTF-8
-require "i15r"
+require 'spec_helper'
+require 'i15r'
 
-describe I15R::Base do
+describe I15R do
 
   before do
-    @i15r = I15R::Base.new
+    @i15r = I15R::Fixture.new
   end
 
   describe "converting file paths to message prefixes" do
@@ -30,87 +31,101 @@ describe I15R::Base do
     end
 
     it "should raise if path does not contain any Rails app directories" do
+      #FIXME: Why should we deal only with Rails apps?
       path = "projects/doodle.rb"
-      lambda { @i15r.file_path_to_message_prefix(path) }.should raise_error(AppFolderNotFound)
+      lambda { @i15r.file_path_to_message_prefix(path) }.should raise_error(I15R::AppFolderNotFound)
     end
   end
 
-  describe "dry_run?" do
-    it "should return true when in dry run mode" do
-      @i15r.options.dry_run = true
-      @i15r.dry_run?.should == true
-    end
-    it "should return false when not in dry run mode" do
-      @i15r.options.dry_run = false
-      @i15r.dry_run?.should == false
+  describe "writing the changed file" do
+    let(:path) { "app/views/users/new.html.erb" }
+    let(:reader) { mock(:read => %Q{<label for="user-name">Name</label>}) }
+    let(:writer) { mock("writer") }
+    let(:printer) { mock("printer") }
+
+    subject { I15R.new(reader, writer, printer) }
+
+    specify do
+      writer.should_receive(:write)
+        .with(path, %Q{<label for="user-name"><%= I18n.t("users.new.name", :default => "Name") %></label>\n})
+      printer.should_receive(:println).with("app/views/users/new.html.erb:")
+      printer.should_receive(:println).with("")
+      printer.should_receive(:print_diff)
+        .with(%Q{<label for="user-name">Name</label>},
+              %Q{<label for="user-name"><%= I18n.t("users.new.name", :default => "Name") %></label>})
+      subject.internationalize_file(path)
     end
   end
 
-  describe "turning plain messages into i18n message strings" do
-    it "should downcase a single word" do
-      I15R::Base.get_i18n_message_string("Name", "users.new").should == "users.new.name"
-    end
 
-    it "should replace spaces with underscores" do
-      I15R::Base.get_i18n_message_string("New name", "users.index").should == "users.index.new_name"
+  describe "generating the prefix" do
+    let(:reader) { mock(:read => %Q{<label for="user-name">Name</label>}) }
+    let(:writer) { mock("writer") }
+
+    subject { I15R.new(reader, writer, I15R::NullPrinter.new) }
+
+    describe "for a view" do
+      let(:path) { "app/views/users/new.html.erb" }
+      specify do
+        writer.should_receive(:write)
+          .with(path, %Q{<label for="user-name"><%= I18n.t("users.new.name", :default => "Name") %></label>\n})
+        subject.internationalize_file(path)
+      end
     end
 
-    it "should not rip out a non-english letter" do
-      I15R::Base.get_i18n_message_string("Mañana", "users.index").should == "users.index.mañana"
+    describe "for a partial" do
+      let(:path) { "app/views/users/_badge.html.erb" }
+      specify do
+        writer.should_receive(:write)
+          .with(path, %Q{<label for="user-name"><%= I18n.t("users.badge.name", :default => "Name") %></label>\n})
+        subject.internationalize_file(path)
+      end
     end
 
-    it "should replace a ' with an underscore" do
-      I15R::Base.get_i18n_message_string("C'est ça", "users.index").should == "users.index.cest_ça"
+    describe "when there is an explicit prefix" do
+      let(:path) { "app/views/users/_badge.html.erb" }
+
+      subject { I15R.new(reader, writer, I15R::NullPrinter.new, :prefix => "nice") }
+
+      specify do
+        writer.should_receive(:write).with(path, %Q{<label for="user-name"><%= I18n.t("nice.name", :default => "Name") %></label>\n})
+        subject.internationalize_file(path)
+      end
     end
   end
 
-  describe "when substituting the plain contents with i18n message strings" do
-    before do
-      @i15r.options.prefix = nil
-      @file_path = "app/views/users/new.html.erb"
-      @i15r.stub(:get_content_from).and_return(%q{<label for=\"user-name\">Name</label>})
-    end
+  describe "the add_default option" do
+    let(:path) { "app/users/views/index.html.haml" }
+    let(:patter_matcher) { mock("pattern matcher", :run => "") }
+    let(:i15r) { I15R::Fixture.new }
+
+    subject { I15R::Fixture.new }
 
-    describe "and in dry-run mode" do
+    describe "when true" do
       before do
-        @i15r.stub!(:dry_run?).and_return(true)
-      end
-      it "should not touch any files" do
-        @i15r.should_not_receive(:write_content_to)
-        @i15r.internationalize_file(@file_path)
+        subject.config = { :add_default => true }
       end
-      it "should display the diff" do
-        @i15r.should_receive(:show_diff)
-        @i15r.internationalize_file(@file_path)
+      specify do
+        I15R::PatternMatcher.should_receive(:new)
+                            .with(anything, anything, hash_including(:add_default => true))
+                            .and_return(patter_matcher)
+        subject.internationalize_file(path)
       end
     end
 
-    describe "and not in dry-run mode" do
+    describe "when false" do
       before do
-        @i15r.stub!(:dry_run?).and_return(false)
+        subject.config = { :add_default => false }
       end
-      it "should write the files" do
-        @i15r.should_receive(:write_content_to)
-        @i15r.internationalize_file(@file_path)
+      specify do
+        I15R::PatternMatcher.should_receive(:new)
+                            .with(anything, anything, hash_including(:add_default => false))
+                            .and_return(patter_matcher)
+        subject.internationalize_file(path)
       end
     end
   end
 
-  describe "when no prefix option was given" do
-    it "should correctly internationalize messages using a prefix derived from the path" do
-      message_prefix = "users.new"
-      plain_snippet = <<-EOS
-        <label for="user-name">Name</label>
-        <input type="text" id="user-name" name="user[name]" />
-      EOS
-      i18ned_snippet = <<-EOS
-        <label for="user-name"><%= I18n.t("#{message_prefix}.name") %></label>
-        <input type="text" id="user-name" name="user[name]" />
-      EOS
-      @i15r.sub_plain_strings(plain_snippet, message_prefix, :erb).should == i18ned_snippet
-    end
-  end # "when no prefix option was given"
-
   describe "when an explicit prefix option was given" do
     it "should correctly internationalize messages using the prefix" do
       prefix_option = "mysite"
@@ -119,7 +134,7 @@ describe I15R::Base do
         <input type="text" id="user-name" name="user[name]" />
       EOS
       i18ned_snippet = <<-EOS
-        <label for="user-name"><%= I18n.t("#{prefix_option}.name") %></label>
+        <label for="user-name"><%= I18n.t("#{prefix_option}.name", :default => "Name") %></label>
         <input type="text" id="user-name" name="user[name]" />
       EOS
 
@@ -127,17 +142,4 @@ describe I15R::Base do
     end
   end # "when an explicit prefix option was given"
 
-  describe "when running the internationalization for an ERB file" do
-    before do
-      @i15r.stub!(:write_content_to).and_return(true)
-      @file_path = "app/views/users/new.html.erb"
-      @i15r.stub(:get_content_from).and_return(%q{<label for=\"user-name\">Name</label>})
-    end
-
-    it "should only run ERB matchers" do
-      @i15r.should_receive(:sub_plain_strings).with(anything, anything, :erb)
-      @i15r.internationalize_file(@file_path)
-    end
-  end
-
 end

data/spec/pattern_matcher_spec.rb

@@ -1,23 +1,199 @@
 # encoding: UTF-8
+require 'spec_helper'
 require 'i15r/pattern_matcher'
 
-describe I15R::PatternMatchers::Base do
-  it "should not replace a simple haml div tag with an id" do
-    plain = %(#main)
-    I15R::PatternMatchers::Base.run(plain, "users.new", :haml).should == plain
-  end
+describe I15R::PatternMatcher do
+
+  subject { pattern_matcher }
+
+  describe "in erb templates" do
+    let(:pattern_matcher) { I15R::PatternMatcher.new("users.new", :erb) }
+
+    describe "in tag content" do
+      it { should internationalize('<h1>New flight</h1>')
+                               .to('<h1><%= I18n.t("users.new.new_flight") %></h1>') }
+      it { should internationalize(%(<label for="user-name">Name</label>))
+                               .to(%(<label for="user-name"><%= I18n.t("users.new.name") %></label>)) }
+
+      it { should internationalize(%(<label for="user-name">First name</label>))
+                               .to(%(<label for="user-name"><%= I18n.t("users.new.first_name") %></label>)) }
+
+      it { should internationalize(%(<label for="user-name">Got friends? A friend's name</label>))
+                               .to(%(<label for="user-name"><%= I18n.t("users.new.got_friends_a_friends_name") %></label>)) }
+
+      it { should internationalize(%(<label for="user-name">A friend's name:</label>))
+                               .to(%(<label for="user-name"><%= I18n.t("users.new.a_friends_name") %></label>)) }
+
+      it { should internationalize(%(<label for="user-name"> Name </label>))
+                               .to(%(<label for="user-name"><%= I18n.t("users.new.name") %></label>)) }
+
+      it { should internationalize(%(<label for="when">Mañana</label>))
+                               .to(%(<label for="when"><%= I18n.t("users.new.mañana") %></label>)) }
+
+      describe "when the default option is given" do
+        let(:pattern_matcher) { I15R::PatternMatcher.new("users.new", :erb, :add_default => true) }
+
+        it { should internationalize('<h1>New flight</h1>')
+                                 .to('<h1><%= I18n.t("users.new.new_flight", :default => "New flight") %></h1>') }
+        it { should internationalize(%(    <%= f.label :name %><br />))
+                                 .to(%(    <%= f.label I18n.t("users.new.name", :default => "name") %><br />)) }
+      end
+
+      describe "when a line is already international" do
+        it { should internationalize(%(  <%= f.label I18n.t("users.new.name") %>)).to_the_same }
+        it { should internationalize(%(  <%= f.label t("users.new.name") %>)).to_the_same }
+      end
+    end
+
+    describe "in tag attributes" do
+      it { should internationalize(%(<a title="site root" href="/"><img src="site_logo.png" /></a>))
+                               .to(%(<a title="<%= I18n.t("users.new.site_root") %>" href="/"><img src="site_logo.png" /></a>)) }
+
+      it { should internationalize(%(<a title="site root" href="/"><img src="site_logo.png" /></a>))
+                               .to(%(<a title="<%= I18n.t("users.new.site_root") %>" href="/"><img src="site_logo.png" /></a>)) }
+    end
+
+    describe "Rails helper methods" do
+      let(:pattern_matcher) { I15R::PatternMatcher.new("users.index", :erb) }
+
+      it { should internationalize(%(<p class="highlighted"><%= link_to 'New user', new_user_path %>?</p>))
+                               .to(%(<p class="highlighted"><%= link_to I18n.t("users.index.new_user"), new_user_path %>?</p>)) }
+
+      it { should internationalize(%(<p><%= link_to "Create a new user", new_user_path, { :class => "add" } -%></p>))
+                               .to(%(<p><%= link_to I18n.t("users.index.create_a_new_user"), new_user_path, { :class => "add" } -%></p>)) }
+
+      it { should internationalize(%(<%= f.label :name, "Name" %>))
+                               .to(%(<%= f.label :name, I18n.t("users.index.name") %>)) }
+
+      it { should internationalize(%(    <%= f.label :name %><br />))
+                               .to(%(    <%= f.label I18n.t("users.index.name") %><br />)) }
+
+      it { should internationalize(%(    <%= label_tag :name, "Real Name" %><br />))
+                               .to(%(    <%= label_tag :name, I18n.t("users.index.real_name") %><br />)) }
+
+      it { should internationalize(%(<%= f.submit "Create user" %>))
+                               .to(%(<%= f.submit I18n.t("users.index.create_user") %>)) }
 
-  it "should properly replace a line with two matches" do
-    plain = %(This is it: <a title="site root" href="/"><img src="site_logo.png" /></a>)
-    i18ned = %(<%= I18n.t("users.new.this_is_it") %>: <a title="<%= I18n.t("users.new.site_root") %>" href="/"><img src="site_logo.png" /></a>)
-    I15R::PatternMatchers::Base.run(plain, "users.new", :erb).should == i18ned
+      it { should internationalize(%(<%= submit_tag "Create user" %>))
+                               .to(%(<%= submit_tag I18n.t("users.index.create_user") %>)) }
+
+      describe "when the default option is given" do
+        let(:pattern_matcher) { I15R::PatternMatcher.new("users.index", :erb, :add_default => true) }
+
+        it { should internationalize(%(<%= submit_tag "Create user" %>))
+                                 .to(%(<%= submit_tag I18n.t("users.index.create_user", :default => "Create user") %>)) }
+      end
+
+      describe "when text has non-ascii characters" do
+        it { should internationalize(%(<p class="highlighted"><%= link_to 'Új felhasználó', new_user_path %>?</p>))
+                                 .to(%(<p class="highlighted"><%= link_to I18n.t("users.index.Új_felhasználó"), new_user_path %>?</p>)) }
+
+        it { should internationalize(%(<p><%= link_to "Új felhasználó létrehozása", new_user_path, { :class => "add" } -%></p>))
+                                 .to(%(<p><%= link_to I18n.t("users.index.Új_felhasználó_létrehozása"), new_user_path, { :class => "add" } -%></p>)) }
+
+        it { should internationalize(%(<%= f.label :name, "Név" %>))
+                                 .to(%(<%= f.label :name, I18n.t("users.index.név") %>)) }
+
+        it { should internationalize(%(<%= label_tag :name, "Név" %>))
+                                 .to(%(<%= label_tag :name, I18n.t("users.index.név") %>)) }
+
+        it { should internationalize(%(  <%= label_tag :name, "Real Name" %><br />))
+                                 .to(%(  <%= label_tag :name, I18n.t("users.index.real_name") %><br />)) }
+
+        it { should internationalize(%(<%= f.submit "Új felhasználó" %>))
+                                 .to(%(<%= f.submit I18n.t("users.index.Új_felhasználó") %>)) }
+
+        it { should internationalize(%(<%= submit_tag "Új felhasználó" %>))
+                                 .to(%(<%= submit_tag I18n.t("users.index.Új_felhasználó") %>)) }
+
+        it { should internationalize(%(<%= f.submit :create_user %>))
+                                 .to(%(<%= f.submit I18n.t("users.index.create_user") %>)) }
+
+        it { should internationalize(%(  <%= f.submit :create_user %>))
+                                 .to(%(  <%= f.submit I18n.t("users.index.create_user") %>)) }
+      end
+    end
   end
 
-  #1.8fail
-  it "should properly replace a line with two matches that have non-ascii chars" do
-    plain = %(C'est ça: <a title="site root" href="/"><img src="site_logo.png" /></a>)
-    i18ned = %(<%= I18n.t("users.new.cest_ça") %>: <a title="<%= I18n.t("users.new.site_root") %>" href="/"><img src="site_logo.png" /></a>)
-    I15R::PatternMatchers::Base.run(plain, "users.new", :erb).should == i18ned
+  describe "in haml templates" do
+    let(:pattern_matcher) { I15R::PatternMatcher.new("users.show", :haml) }
+
+    it { should internationalize('#main').to_the_same }
+
+    it { should internationalize(%(#form_head My account))
+                             .to(%(#form_head= I18n.t("users.show.my_account"))) }
+
+    it { should internationalize(%(%p Please check your inbox and click on the activation link.))
+                             .to(%(%p= I18n.t("users.show.please_check_your_inbox_and_click_on_the_activation_link"))) }
+
+    it { should internationalize("please visit").to('= I18n.t("users.show.please_visit")') }
+    it { should internationalize("Mañana").to('= I18n.t("users.show.mañana")') }
+    it { should internationalize("C'est ça").to('= I18n.t("users.show.cest_ça")') }
+    it { should internationalize(%(%p Do not close/reload while loading))
+                             .to(%(%p= I18n.t("users.show.do_not_close_reload_while_loading"))) }
+    it { should internationalize(%(        .field)).to(%(        .field)) }
+    it { should internationalize('%p').to_the_same }
+    it { should internationalize(%(%h2 Resend unlock instructions))
+                             .to(%(%h2= I18n.t("users.show.resend_unlock_instructions"))) }
+    it { should internationalize(%(%i (we need your password to confirm your changes)))
+                             .to(%(%i= I18n.t("users.show.we_need_your_password_to_confirm_your_changes"))) }
+    it { should internationalize('= yield').to_the_same }
+    it { should internationalize('/ Do not remove the next line').to_the_same }
+    it { should internationalize(%(#form_head Türkçe))
+                             .to(%(#form_head= I18n.t("users.show.türkçe"))) }
+    it { should internationalize(%(%p Egy, kettő, három, négy, öt.))
+                             .to(%(%p= I18n.t("users.show.egy_kettő_három_négy_öt"))) }
+    it { should internationalize(%(Türkçe)).to(%(= I18n.t("users.show.türkçe"))) }
+    it { should internationalize(%(  %h3 Top Scorers))
+                             .to(%(  %h3= I18n.t("users.show.top_scorers"))) }
+    it { should internationalize(%(        %div{ :class => "field option", :style => "float:left" })).to_the_same }
+    it { should internationalize(%(        %div{ :class => "field option", :style => "float:left" } Name))
+                             .to(%(        %div{ :class => "field option", :style => "float:left" }= I18n.t("users.show.name"))) }
+    it { should internationalize(%(        %div(class: "field option", style: "float:left") Name))
+                             .to(%(        %div(class: "field option", style: "float:left")= I18n.t("users.show.name"))) }
+
+    describe "when the default option is given" do
+      let(:pattern_matcher) { I15R::PatternMatcher.new("users.show", :haml, :add_default => true) }
+      it { should internationalize(%(  %h3 Top Scorers))
+                               .to(%(  %h3= I18n.t("users.show.top_scorers", :default => "Top Scorers"))) }
+    end
+
+    describe "when already evaluated" do
+      it { should internationalize(%(%p= link_to 'New user', new_user_path))
+                               .to(%(%p= link_to I18n.t("users.show.new_user"), new_user_path)) }
+      it { should internationalize(%(= f.label :password, "Password"))
+                               .to(%(= f.label :password, I18n.t("users.show.password"))) }
+      it { should internationalize(%(    = f.label :password, "Password"))
+                               .to(%(    = f.label :password, I18n.t("users.show.password"))) }
+      it { should internationalize(%(%p= link_to 'Új felhasználó', new_user_path))
+                               .to(%(%p= link_to I18n.t("users.show.Új_felhasználó"), new_user_path)) }
+      it { should internationalize(%(#new_user_link= link_to 'Új felhasználó', new_user_path))
+                               .to(%(#new_user_link= link_to I18n.t("users.show.Új_felhasználó"), new_user_path)) }
+      it { should internationalize(%(= f.label :password, "Contraseña"))
+                               .to(%(= f.label :password, I18n.t("users.show.contraseña"))) }
+      it { should internationalize(%(    = f.label :password, "Contraseña"))
+                               .to(%(    = f.label :password, I18n.t("users.show.contraseña"))) }
+      it { should internationalize(%(    = f.label :name))
+                               .to(%(    = f.label I18n.t("users.show.name"))) }
+
+      it { should internationalize(%(= f.submit "Create user"))
+                               .to(%(= f.submit I18n.t("users.show.create_user"))) }
+      it { should internationalize(%(= submit_tag "Create user"))
+                               .to(%(= submit_tag I18n.t("users.show.create_user"))) }
+      it { should internationalize(%(  = f.submit :user_details %>))
+                               .to(%(  = f.submit I18n.t("users.show.user_details") %>)) }
+      it { should internationalize(%(  = submit_tag :user_details %>))
+                               .to(%(  = submit_tag I18n.t("users.show.user_details") %>)) }
+    end
+
+    describe "evaluated ruby code" do
+      it { should internationalize('- if foo == :bar').to_the_same }
+    end
+
+    describe "when a line is already international" do
+      it { should internationalize(%(  = f.label I18n.t("users.new.name") )).to_the_same }
+      it { should internationalize(%(  = f.label t("users.new.name") )).to_the_same }
+    end
   end
 
 end

data/spec/spec_helper.rb

@@ -1,4 +1,39 @@
-$:.unshift File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib")
+current_dir = File.expand_path(File.dirname(__FILE__))
+$:.unshift File.join(current_dir, "..", "lib")
 
 require 'i15r'
-require 'i15r/pattern_matchers/haml'
+require 'i15r/file_reader'
+
+Dir["#{current_dir}/support/**/*.rb"].each do |file|
+  require file
+end
+
+class I15R
+  class StringReader
+    def read(path)
+      "norf"
+    end
+  end
+
+  class NullWriter
+    def write(path, content); end
+  end
+  class NullPrinter
+    def print_diff(old_row, new_row); end
+    def println(text); end
+  end
+
+  class Fixture < I15R
+    def initialize(reader=StringReader.new,
+                   writer=NullWriter.new,
+                   printer=NullPrinter.new,
+                   config={})
+      super(reader, writer, printer, config)
+    end
+
+    def self.with_config(config)
+      new(StringReader.new, NullWriter.new, NullPrinter.new, config)
+    end
+  end
+end
+