writeexcel 0.6.7 → 0.6.8

data/README.rdoc

@@ -77,6 +77,9 @@ when use urf8 string data.
 
 == Recent Changes
 
+v0.6.8
+* Bug fix. Worksheet#protect doesn't work well.
+
 v0.6.7
 * Bug fix. Worksheet#set_first_sheet doesn't work well.
 * Bug fix. Worksheet#hide_zero doesn't work well.

data/VERSION

@@ -1 +1 @@
-0.6.7
+0.6.8

data/examples/password_protection.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'writeexcel'
+
+  workbook = WriteExcel.new('password_protection.xls')
+  worksheet = workbook.add_worksheet
+
+    # Create some format objects
+    locked    = workbook.add_format(:locked => 1)
+    unlocked  = workbook.add_format(:locked => 0)
+    hidden    = workbook.add_format(:hidden => 1)
+
+    # Format the columns
+    worksheet.set_column('A:A', 42)
+    worksheet.set_selection('B3:B3')
+
+    # Protect the worksheet
+    worksheet.protect('password')
+
+    # Examples of cell locking and hiding
+    worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+    worksheet.write('B1', '=1+2', locked)
+
+    worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+    worksheet.write('B2', '=1+2', unlocked)
+
+    worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+    worksheet.write('B3', '=1+2', hidden)
+
+    worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+    worksheet.write('A6', 'to remove the worksheet protection.   ')
+    worksheet.write('A7', 'The password is "password".   ')
+
+    workbook.close

data/html/en/doc_en.html

@@ -968,7 +968,7 @@ name="write_string"
 
 <pre>
     # Format as a string. Doesn&#39;t change to a number when edited
-    format1 = workbook.add_format(num_format =&#62; &#39;@&#39;)
+    format1 = workbook.add_format(:num_format =&#62; &#39;@&#39;)
     worksheet.write_string(&#39;A2&#39;, &#39;01209&#39;, format1)
 </pre>
 
@@ -1084,7 +1084,7 @@ name="write_col"
 <p>The <code>write_col</code> method can be used to write a 1D or 2D array of data in one go. This is useful for converting the results of a database query into an Excel worksheet. You must pass a reference to the array of data rather than the array itself. The <code>write</code> method is then called for each element of the data. For example:</p>
 
 <pre>
-    array      = [39;awk&#39;, &#39;gawk&#39;, &#39;mawk&#39;]
+    array      = [&#39;awk&#39;, &#39;gawk&#39;, &#39;mawk&#39;]
 
     worksheet.write_col(0, 0, array)
 
@@ -1173,7 +1173,7 @@ name="write_date_time"
 >&#34;CELL FORMATTING&#34;</a>. Here is a typical example:</p>
 
 <pre>
-    date_format = workbook.add_format(num_format =&#62; &#39;mm/dd/yy&#39;)
+    date_format = workbook.add_format(:num_format =&#62; &#39;mm/dd/yy&#39;)
     worksheet.write_date_time(&#39;A1&#39;, &#39;2004-05-13T23:20&#39;, date_format)
 </pre>
 
@@ -1457,7 +1457,7 @@ name="write_comment"
 <p>This option is used to indicate that the comment string is encoded as <code>UTF-16BE</code>.</p>
 
 <pre>
-    comment = pack &#39;n&#39;, 0x263a; # UTF-16BE Smiley symbol
+    comment = [0x263a].pack('n')   # UTF-16BE Smiley symbol
 
     worksheet.write_comment(&#39;C3&#39;, comment, :encoding =&#62; 1)
 </pre>
@@ -1675,7 +1675,7 @@ name="insert_chart"
 <p>This method can be used to insert a Chart object into a worksheet. The Chart must be created by the <code>add_chart</code> Workbook method and it must have the <code>embedded</code> option set.</p>
 
 <pre>
-    chart = workbook.add_chart( type =&#62; &#39;Chart::Line&#39;, :embedded =&#62; true )
+    chart = workbook.add_chart( :type =&#62; &#39;Chart::Line&#39;, :embedded =&#62; true )
 
     # Configure the chart.
     ...
@@ -1831,8 +1831,8 @@ name="protect"
 
 <pre>
     # Set some format properties
-    unlocked  = workbook.add_format(locked =&#62; 0)
-    hidden    = workbook.add_format(hidden =&#62; 1)
+    unlocked  = workbook.add_format(:locked =&#62; 0)
+    hidden    = workbook.add_format(:hidden =&#62; 1)
 
     # Enable worksheet protection
     worksheet.protect
@@ -2109,9 +2109,9 @@ name="merge_range"
 
 <pre>
     format = workbook.add_format(
-                                        border  =&#62; 6,
-                                        valign  =&#62; &#39;vcenter&#39;,
-                                        align   =&#62; &#39;center&#39;,
+                                        :border  =&#62; 6,
+                                        :valign  =&#62; &#39;vcenter&#39;,
+                                        :align   =&#62; &#39;center&#39;,
                                       )
 
     worksheet.merge_range(&#39;B3:D4&#39;, &#39;Vertical and horizontal&#39;, format)
@@ -2592,7 +2592,7 @@ name="set_landscape"
 <p>This method is used to set the orientation of a worksheet&#39;s printed page to landscape:</p>
 
 <pre>
-    worksheet.set_landscape; # Landscape mode
+    worksheet.set_landscape  # Landscape mode
 </pre>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
@@ -2602,7 +2602,7 @@ name="set_portrait"
 <p>This method is used to set the orientation of a worksheet&#39;s printed page to portrait. The default worksheet orientation is portrait, so you won&#39;t generally need to call this method.</p>
 
 <pre>
-    worksheet.set_portrait; # Portrait mode
+    worksheet.set_portrait  # Portrait mode
 </pre>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
@@ -2707,10 +2707,10 @@ name="set_margins"
     set_margins        # Set all margins to the same value
     set_margins_LR     # Set left and right margins to the same value
     set_margins_TB     # Set top and bottom margins to the same value
-    set_margin_left;   # Set left margin
-    set_margin_right;  # Set right margin
-    set_margin_top;    # Set top margin
-    set_margin_bottom; # Set bottom margin
+    set_margin_left    # Set left margin
+    set_margin_right   # Set right margin
+    set_margin_top     # Set top margin
+    set_margin_bottom  # Set bottom margin
 </pre>
 
 <p>All of these methods take a distance in inches as a parameter. Note: 1 inch = 25.4mm. ;-) The default left and right margin is 0.75 inch. The default top and bottom margin is 1.00 inch.</p>
@@ -3226,7 +3226,7 @@ name="Working_with_formats"
 
 <pre>
     format1 = workbook.add_format
-    format1.set_bold;  # Turns bold on
+    format1.set_bold    # Turns bold on
     format1.set_bold(1) # Also turns bold on
     format1.set_bold(0) # Turns bold off
 </pre>
@@ -3275,7 +3275,7 @@ name="FORMAT_METHODS"
     set_right_color
 </pre>
 
-<p>The above methods can also be applied directly as properties. For example <code>format.set_bold</code> is equivalent to <code>workbook.add_format(bold =&#62; 1)</code>.</p>
+<p>The above methods can also be applied directly as properties. For example <code>format.set_bold</code> is equivalent to <code>workbook.add_format(:bold =&#62; 1)</code>.</p>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
 name="set_format_properties"
@@ -3285,13 +3285,13 @@ name="set_format_properties"
 
 <pre>
     format = workbook.add_format
-    format.set_format_properties(bold =&#62; 1, color =&#62; &#39;red&#39;)
+    format.set_format_properties(:bold =&#62; 1, :color =&#62; &#39;red&#39;)
 </pre>
 
 <p>However, this method is here mainly for legacy reasons. It is preferable to set the properties in the format constructor:</p>
 
 <pre>
-    format = workbook.add_format(bold =&#62; 1, color =&#62; &#39;red&#39;)
+    format = workbook.add_format(:bold =&#62; 1, :color =&#62; &#39;red&#39;)
 </pre>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
@@ -3383,7 +3383,7 @@ name="set_bold"
 <p>Set the bold property of the font:</p>
 
 <pre>
-    format.set_bold;  # Turn bold on
+    format.set_bold   # Turn bold on
 </pre>
 
 <p>[1] Actually, values in the range 100..1000 are also valid. 400 is normal, 700 is bold and 1000 is very bold indeed. It is probably best to set the value to 1 and use normal bold.</p>
@@ -3401,7 +3401,7 @@ name="set_italic"
 <p>Set the italic property of the font:</p>
 
 <pre>
-    format.set_italic;  # Turn italic on
+    format.set_italic   # Turn italic on
 </pre>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
@@ -3421,7 +3421,7 @@ name="set_underline"
 <p>Set the underline property of the font.</p>
 
 <pre>
-    format.set_underline;   # Single underline
+    format.set_underline    # Single underline
 </pre>
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
@@ -3846,7 +3846,7 @@ name="set_bg_color"
 <pre>
     format = workbook.add_format
 
-    format.set_pattern; # This is optional when using a solid fill
+    format.set_pattern  # This is optional when using a solid fill
 
     format.set_bg_color(&#39;green&#39;)
     worksheet.write(&#39;A1&#39;, &#39;Ray&#39;, format)
@@ -4142,11 +4142,11 @@ name="Chart_names_and_Unicode"
 <p>You can write Unicode strings as UTF-16BE by adding a <code>name_encoding</code> property:</p>
 
 <pre>
-    utf16be_name = pack &#39;n&#39;, 0x263A;
+    utf16be_name = [0x263a].pack('n')
 
     chart.set_title(
-      name          =&#62; utf16be_name,
-      name_encoding =&#62; 1,
+      :name          =&#62; utf16be_name,
+      :name_encoding =&#62; 1,
     )
 </pre>
 
@@ -4195,22 +4195,22 @@ name="An_Excel_date_time_is_a_number_plus_a_format"
 
     worksheet.write(&#39;A1&#39;, number)            #     39506.5
 
-    format2 = workbook.add_format(num_format =&#62; &#39;dd/mm/yy&#39;)
+    format2 = workbook.add_format(:num_format =&#62; &#39;dd/mm/yy&#39;)
     worksheet.write(&#39;A2&#39;, number , format2) #     28/02/08
 
-    format3 = workbook.add_format(num_format =&#62; &#39;mm/dd/yy&#39;)
+    format3 = workbook.add_format(:num_format =&#62; &#39;mm/dd/yy&#39;)
     worksheet.write(&#39;A3&#39;, number , format3) #     02/28/08
 
-    format4 = workbook.add_format(num_format =&#62; &#39;d-m-yyyy&#39;)
+    format4 = workbook.add_format(:num_format =&#62; &#39;d-m-yyyy&#39;)
     worksheet.write(&#39;A4&#39;, number , format4) #     28-2-2008
 
-    format5 = workbook.add_format(num_format =&#62; &#39;dd/mm/yy hh:mm&#39;)
+    format5 = workbook.add_format(:num_format =&#62; &#39;dd/mm/yy hh:mm&#39;)
     worksheet.write(&#39;A5&#39;, number , format5) #     28/02/08 12:00
 
-    format6 = workbook.add_format(num_format =&#62; &#39;d mmm yyyy&#39;)
+    format6 = workbook.add_format(:num_format =&#62; &#39;d mmm yyyy&#39;)
     worksheet.write(&#39;A6&#39;, number , format6) #     28 Feb 2008
 
-    format7 = workbook.add_format(num_format =&#62; &#39;mmm d yyyy hh:mm AM/PM&#39;)
+    format7 = workbook.add_format(:num_format =&#62; &#39;mmm d yyyy hh:mm AM/PM&#39;)
     worksheet.write(&#39;A7&#39;, number , format7) #     Feb 28 2008 12:00 PM
 </pre>
 
@@ -4254,7 +4254,7 @@ name="WriteExcel_doesnt_automatically_convert_date_time_strings"
     worksheet   = workbook.add_worksheet
 
     # Set the default format for dates.
-    date_format = workbook.add_format(num_format =&#62; &#39;mmm d yyyy&#39;)
+    date_format = workbook.add_format(:num_format =&#62; &#39;mmm d yyyy&#39;)
 
     # Increase column width to improve visibility of data.
     worksheet.set_column(&#39;A:C&#39;, 20)
@@ -4419,7 +4419,7 @@ name="DATA_VALIDATION_IN_EXCEL"
 
 <h2><a class='u' href='#___top' title='click to go to top of document'
 name="data_validation"
->data_validation(row, col, { parameter =&#62; &#39;value&#39;, ... })</a></h2>
+>data_validation(row, col, { :parameter =&#62; &#39;value&#39;, ... })</a></h2>
 
 <p>The <code>data_validation</code> method is used to construct an Excel data validation.</p>
 
@@ -5448,12 +5448,12 @@ name="Example_7"
     bold      = workbook.add_format( :bold => 1 )
 
     # Add the worksheet data that the charts will refer to.
-    headings = [ 'Number', 'Sample 1', 'Sample 2' ];
+    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
     data = [
         [ 2, 3, 4, 5, 6, 7 ],
         [ 1, 4, 5, 2, 1, 5 ],
         [ 3, 6, 7, 5, 4, 3 ],
-    ];
+    ]
 
     worksheet.write( 'A1', headings, bold )
     worksheet.write( 'A2', data )
@@ -5508,12 +5508,12 @@ name="Example_8"
     bold      = workbook.add_format( :bold => 1 )
 
     # Add the worksheet data that the charts will refer to.
-    headings = [ 'Number', 'Sample 1', 'Sample 2' ];
+    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
     data = [
         [ 2, 3, 4, 5, 6, 7 ],
         [ 1, 4, 5, 2, 1, 5 ],
         [ 3, 6, 7, 5, 4, 3 ],
-    ];
+    ]
 
     worksheet.write( 'A1', headings, bold )
     worksheet.write( 'A2', data )
@@ -5568,12 +5568,12 @@ name="Example_9"
     bold      = workbook.add_format( :bold => 1 )
 
     # Add the worksheet data that the charts will refer to.
-    headings = [ 'Number', 'Sample 1', 'Sample 2' ];
+    headings = [ 'Number', 'Sample 1', 'Sample 2' ]
     data = [
         [ 2, 3, 4, 5, 6, 7 ],
         [ 1, 4, 5, 2, 1, 5 ],
         [ 3, 6, 7, 5, 4, 3 ],
-    ];
+    ]
 
     worksheet.write( 'A1', headings, bold )
     worksheet.write( 'A2', data )

data/lib/writeexcel/worksheet.rb

@@ -5008,12 +5008,12 @@ def sort_pagebreaks(breaks)       #:nodoc:
   #
   # Based on the algorithm provided by Daniel Rentz of OpenOffice.
   #
-  def encode_password(password)       #:nodoc:
+  def encode_password(password)
     i = 0
     chars = password.split(//)
     count = chars.size
 
-    chars.each do |char|
+    chars.collect! do |char|
       i += 1
       char     = char[0] << i
       low_15   = char & 0x7fff

data/test/test_example_match.rb

@@ -1203,6 +1203,42 @@ def test_protection
     compare_file("#{PERL_OUTDIR}/protection.xls", @file)
   end
 
+  def test_password_protection
+    workbook  = WriteExcel.new(@file)
+    worksheet = workbook.add_worksheet
+
+    # Create some format objects
+    locked    = workbook.add_format(:locked => 1)
+    unlocked  = workbook.add_format(:locked => 0)
+    hidden    = workbook.add_format(:hidden => 1)
+
+    # Format the columns
+    worksheet.set_column('A:A', 42)
+    worksheet.set_selection('B3:B3')
+
+    # Protect the worksheet
+    worksheet.protect('password')
+
+    # Examples of cell locking and hiding
+    worksheet.write('A1', 'Cell B1 is locked. It cannot be edited.')
+    worksheet.write('B1', '=1+2', locked)
+
+    worksheet.write('A2', 'Cell B2 is unlocked. It can be edited.')
+    worksheet.write('B2', '=1+2', unlocked)
+
+    worksheet.write('A3', "Cell B3 is hidden. The formula isn't visible.")
+    worksheet.write('B3', '=1+2', hidden)
+
+    worksheet.write('A5', 'Use Menu->Tools->Protection->Unprotect Sheet')
+    worksheet.write('A6', 'to remove the worksheet protection.   ')
+    worksheet.write('A7', 'The password is "password".   ')
+
+    workbook.close
+
+    # do assertion
+    compare_file("#{PERL_OUTDIR}/password_protection.xls", @file)
+  end
+
   def test_date_time
     # Create a new workbook and add a worksheet
     workbook  = WriteExcel.new(@file)

data/writeexcel.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{writeexcel}
-  s.version = "0.6.7"
+  s.version = "0.6.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Hideo NAKAMURA"]
-  s.date = %q{2011-07-03}
+  s.date = %q{2011-07-30}
   s.description = %q{Multiple worksheets can be added to a workbook and formatting can be applied to cells. Text, numbers, formulas, hyperlinks and images can be written to the cells.}
   s.email = %q{cxn03651@msj.biglobe.ne.jp}
   s.extra_rdoc_files = [
@@ -68,6 +68,7 @@ Gem::Specification.new do |s|
     "examples/outline.rb",
     "examples/outline_collapsed.rb",
     "examples/panes.rb",
+    "examples/password_protection.rb",
     "examples/properties.rb",
     "examples/properties_jp.rb",
     "examples/protection.rb",
@@ -181,6 +182,7 @@ Gem::Specification.new do |s|
     "test/perl_output/outline.xls",
     "test/perl_output/outline_collapsed.xls",
     "test/perl_output/panes.xls",
+    "test/perl_output/password_protection.xls",
     "test/perl_output/protection.xls",
     "test/perl_output/regions.xls",
     "test/perl_output/right_to_left.xls",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: writeexcel
 version: !ruby/object:Gem::Version
-  version: 0.6.7
+  version: 0.6.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-03 00:00:00.000000000 +09:00
+date: 2011-07-30 00:00:00.000000000 +09:00
 default_executable: 
 dependencies: []
 description: Multiple worksheets can be added to a workbook and formatting can be
@@ -73,6 +73,7 @@ files:
 - examples/outline.rb
 - examples/outline_collapsed.rb
 - examples/panes.rb
+- examples/password_protection.rb
 - examples/properties.rb
 - examples/properties_jp.rb
 - examples/protection.rb
@@ -186,6 +187,7 @@ files:
 - test/perl_output/outline.xls
 - test/perl_output/outline_collapsed.xls
 - test/perl_output/panes.xls
+- test/perl_output/password_protection.xls
 - test/perl_output/protection.xls
 - test/perl_output/regions.xls
 - test/perl_output/right_to_left.xls