rdo-sqlite 0.0.5 → 0.0.6

data/README.md

@@ -5,8 +5,8 @@ This is the SQLite3 driver for [RDO—Ruby Data Objects]
 
 [![Build Status](https://secure.travis-ci.org/d11wtq/rdo-sqlite.png?branch=master)](http://travis-ci.org/d11wtq/rdo-sqlite)
 
-Refer to the RDO project [README](https://github.com/d11wtq/rdo) for usage
-information.
+Refer to the [RDO project README](https://github.com/d11wtq/rdo) for full
+usage information.
 
 ## Installation
 
@@ -27,7 +27,6 @@ And install with Bundler:
 The registered URI schemes are sqlite: and sqlite3:
 
 ``` ruby
-require "rdo"
 require "rdo-sqlite"
 
 # use an in-memory database :memory:
@@ -41,37 +40,68 @@ db = RDO.open("sqlite:some/path/to/your.db")
 
 # use an absolute path to a database
 db = RDO.open("sqlite:/absolute/path/to/your.db")
-```
-
-## Type casting and bind parameters
 
-SQLite, being a very basic database only has limited type support. Without
-going into the whole discussion about SQLite's "type affinity" and how it
-will effectively store anything in any column declared as any type, know that
-the only internal types it actually stores are:
-
-  - NULL, which converts to nil in Ruby
-  - TEXT, which converts to a UTF-8 encoded String in Ruby
-  - INTEGER, which converts to a Fixnum in Ruby
-  - REAL, which converts to a Float in Ruby
-  - BLOB, which converts to a binary String in Ruby
+# open in read-only mode
+db = RDO.open("sqlite:/path/to/your.db?mode=readonly")
+```
 
-If you have fields storing date strings etc, they are just Text, so are
-returned as Strings, which you need to convert by hand. SQLite has no actual
-DATE type, even if its date functions operate on strings formatted correctly.
+## Type support
+
+SQLite has extremely limited type support. In fact, it only supports five
+types. It allows other types to be specified as column types, but they will
+be one of the core five types. It also allows storing any value of any type
+in any column, regardless of what the column type is. You can read about that
+[here](http://www.sqlite.org/datatype3.html).
+
+The five data types are mapped as below:
+
+<table>
+  <thead>
+    <tr>
+      <th>SQLite Type</th>
+      <th>Ruby Type</th>
+      <th>Notes</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <th>NULL</th>
+      <td>NilClass</td>
+      <td></td>
+    </tr>
+    <tr>
+      <th>TEXT</th>
+      <td>String</td>
+      <td>The encoding is always UTF-8</td>
+    </tr>
+    <tr>
+      <th>INTEGER</th>
+      <td>Fixnum</td>
+      <td></td>
+    </tr>
+    <tr>
+      <th>REAL</th>
+      <td>Float</td>
+      <td></td>
+    </tr>
+    <tr>
+      <th>BLOB</th>
+      <td>String</td>
+      <td>The encoding is always ASCII-8BIT/BINARY</td>
+    </tr>
+  </tbody>
+</table>
 
 ### Boolean types
 
 Because defining fields as BOOLEAN and storing integer 0 or 1 in them is
-common, rdo-sqlite will convert boolean bind parameters to 0 or 1. If you
-actually want to store the String 'true' or 'false', you will need to
-convert it to a String first.
+common, rdo-sqlite will convert boolean bind parameters to 0 or 1.
 
 ### Character encoding
 
 SQLite does not allow the encoding of an existing database to be changed. It
-only supports two encodings: UTF-8 and UTF-16. rdo-sqlite currently just
-assumes UTF-8 encoding.
+only supports two encodings for new databases: UTF-8 and UTF-16. rdo-sqlite
+currently just assumes UTF-8 encoding. Support for UTF-16 is planned.
 
 ## Contributing
 
@@ -79,8 +109,7 @@ If you find any bugs, please send a pull request if you think you can
 fix it, or file in an issue in the issue tracker.
 
 When sending pull requests, please use topic branches—don't send a pull
-request from the master branch of your fork, as that may change
-unintentionally.
+request from the master branch of your fork.
 
 Contributors will be credited in this README.
 

data/ext/rdo_sqlite/driver.c

@@ -26,6 +26,14 @@ static VALUE rdo_sqlite_driver_allocate(VALUE klass) {
   return Data_Wrap_Struct(klass, 0, rdo_sqlite_driver_free, driver);
 }
 
+/** Set the correct mode flags, based on the driver options */
+static int rdo_sqlite_driver_mode(VALUE self) {
+  if (rb_funcall(self, rb_intern("readonly?"), 0) == Qtrue)
+    return SQLITE_OPEN_READONLY;
+  else
+    return SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE;
+}
+
 /** Opens a database */
 static VALUE rdo_sqlite_driver_open(VALUE self) {
   RDOSQLiteDriver * driver;
@@ -38,7 +46,7 @@ static VALUE rdo_sqlite_driver_open(VALUE self) {
   if (sqlite3_open_v2(
         RSTRING_PTR(rb_funcall(self, rb_intern("filename"), 0)),
         &(driver->db),
-        SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, NULL) != SQLITE_OK) {
+        rdo_sqlite_driver_mode(self), NULL) != SQLITE_OK) {
     RDO_ERROR("SQLite3 database open failed: %s", sqlite3_errmsg(driver->db));
   } else {
     driver->is_open = 1;

data/lib/rdo/sqlite/driver.rb

@@ -9,10 +9,30 @@ module RDO
   module SQLite
     # Main Driver class to hook into sqlite3 API
     class Driver < RDO::Driver
+      # Execute a single statement.
+      #
+      # This method delegates to #prepare, then executes.
+      #
+      # @param [String] stmt
+      #   the statement to execute, with optional bind markers
+      #
+      # @param [Object...] *args
+      #   bind parameters
+      #
+      # @return [RDO::Result]
+      #   the result of executing the statement
       def execute(stmt, *args)
         prepare(stmt).execute(*args)
       end
 
+      # Predicte check to see if this is a read-only database.
+      #
+      # @return [Boolean]
+      #   true if ?mode=ro
+      def readonly?
+        %w[ro readonly].include?(options[:mode])
+      end
+
       private
 
       def filename

data/lib/rdo/sqlite/version.rb

@@ -7,6 +7,6 @@
 
 module RDO
   module SQLite
-    VERSION = "0.0.5"
+    VERSION = "0.0.6"
   end
 end

data/spec/sqlite/driver_spec.rb

@@ -73,6 +73,14 @@ describe RDO::SQLite::Driver do
         end
       end
     end
+
+    context "in read-only mode" do
+      let(:options) { "sqlite::memory:?mode=readonly" }
+
+      it "opens the database" do
+        db.should be_open
+      end
+    end
   end
 
   describe "#close" do
@@ -237,6 +245,35 @@ describe RDO::SQLite::Driver do
     end
   end
 
+  context "in readonly mode" do
+    let(:options) { "sqlite:./tmp/test.db?mode=readonly" }
+
+    before(:each) do
+      RDO.open("sqlite:./tmp/test.db?mode=rw") do |db|
+        db.execute("CREATE TABLE bob (id integer primary key)")
+        db.close
+      end
+    end
+
+    after(:each) do
+      File.delete("./tmp/test.db") rescue nil
+    end
+
+    context "on write" do
+      it "raises an RDO::Exception on write" do
+        expect {
+          db.execute("DROP TABLE bob")
+        }.to raise_error(RDO::Exception)
+      end
+    end
+
+    context "on read" do
+      it "returns an RDO::Result" do
+        db.execute("SELECT * FROM bob").should be_a_kind_of(RDO::Result)
+      end
+    end
+  end
+
   describe "#prepare" do
     before(:each) do
       db.execute("CREATE TABLE test (id integer primary key, name text, age integer)")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rdo-sqlite
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-14 00:00:00.000000000 Z
+date: 2012-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rdo