Sinatra+SQLite3+DataMapper - 十分完整的tutorial

原文地址：https://ididitmyway.herokuapp.com/past/2010/3/30/superdo_a_sinatra_and_datamapper_to_do_list/

这个tutorial说明：怎么构建一个list app，其中要用到数据库来保存task。

tutorial概括以下技术：

安装 SQLite and Datamapper
连接数据库
数据库中的CRUD 动作
REST风格的urls

我在这里主要做的是根据我的实际操作和理解，把整个过程用我熟悉的中国话记录下来，以便下次我还能根据它实现或修改这个App，仅此而已。

开始tutorial前，确保已经安装了Sinatra、Ruby和Ruby Gems。

安装 SQLite and Datamapper

这里使用SQLite作为数据库；使用Datamapper作为ORM连接数据库。

如果你在用Ubuntu/Debian系统，这样安装SQLite

sudo aptitude install sqlite3

gem install sqlite3-ruby --  --with-sqlite3-dir=/usr/local/lib

这样安装DataMapper GEM

sudo gem install data_mapper

还有一个adapter，连接DataMapper到数据库用的

sudo gem install dm-sqlite-adapter

Note：原文还有Heroku的相关设置，我省略了。

连接到数据库（可能包括：产生、连接、插入、查询、删除等等）

在项目根目录建立main.rb文件，它之后就是此App的主文件。内容如下：

require 'rubygems'
require 'sinatra'
require 'data_mapper'
 
DataMapper.setup(:default,ENV['DATABASE_URL'] || "sqlite3://#{Dir.pwd}/development.db")
 
#定义数据类（model class）
class Task
	include DataMapper::Resource #用include方式包含DM的功能，而没有使用继承
	property :id,Serial
	property :name,String
	property :completed_at,DateTime
end
 
DataMapper.auto_upgrade!

bit by bit：点点滴滴

代码说明：

1. first bit（第一部分）

require 'rubygems'
require 'sinatra'
require 'data_mapper'

　　请求必要的gems。

2. next bit

DataMapper.setup(:default, ENV['DATABASE_URL'] || "sqlite3://#{Dir.pwd}/development.db")

它是数据库连接字符串。ENV['DATABASE_URL'] || "sqlite3://#{Dir.pwd}/development.db" 在使用Heroku是首选连接到在线数据库，如果没有才会连接本地的development.db。

而且，如果你还没有产生development.db，运行以上代码会自动产生数据库文件。

3. Next part 是Task Class定义。

值得注意的是第一行定义的：id，它是unique的，且由于类型是Srial导致其auto-increment

:completed_at,DateTime这一行告诉我们：Any task with a value of nil, will not have been completed.（没设置completed的Task，其completed_at=nil）

4.Last part of code

让DataMapper更新数据库，将Task的改变提交上去。this means（通过这种方式）甚至可以把增加／删除属性（Task类的）反映到数据库中。

如果想wipe away（擦去）所有数据（？），可以用DataMapper::auto_migrate!，但是使用要小心！！！

数据库准备好了，现在可以不用web界面，在终端状态下浏览（巡视）一下你的数据库

在终端输入：

irb -r ./main.rb

说明：这会打开一个irb shell，-r 参数使得.rb 文件中的代码被包含在这个shell中。在这里，你已经连接好了数据库，现在试试［新建］［编辑］［查找］［删除］Task吧！

下面的操作都是Task Class最常用的，我直接引用原文啦

进入irb shell :

>$ irb -r main.rb

First Task.all , 查看 all our tasks:

$irb(main): > Task.all
=> [] #返回［］表示还没有

so let’s create one:

$irb(main): > t = Task.new
=> #<Task @id=nil @name=nil @completed_at=nil>
$irb(main): > t.name = "Get milk"
=> "Get milk"

Task.new 对象在内存中 in memory - 还要手工存入数据库：

irb(main):007:0> t.save
=> true

查看一下：

irb(main):008:0> Task.first
=> #<Task @id=1 @name="Get milk" @completed_at=nil>

什么时候都可以用Task.create()创建，显然这是类方法：

irb(main):009:0> Task.create(:name => "Get bananas")
=> #<Task @id=2 @name="Get bananas" @completed_at=nil>

Notice用这种方式创建的，不需要手工save，它已经存入数据库了。

irb(main):010:0> Task.all
=> [#<Task @id=1 @name="Get milk" @completed_at=nil>, #<Task @id=2 @name="Get bananas" @completed_at=nil>]

Task.all返回一个集合collection，因此它的count method返回内容的数量:

irb(main):011:0> Task.all.count
=> 2

This shows us that there are currently two tasks saved in the database.

That has covered creating and reading records in our database. Now let’s have a look at updating. Let’s say that we want to get half fat milk. First we need to find that record.

irb(main):012:0> t = Task.first(:name => "Get milk") #这样会返回第一个名字是“Get milk“的记录
=> #<Task @id=1 @name="Get milk" @completed_at=nil>

This is an example of how to find records in the database using certain parameters. In this case we wanted the task with the name “Get milk”. This is now stored in the variable t.

更新记录有两种办法：

The first way 手工修改＆＆ save 保存，

irb(main):014:0> t.name = "Get half fat milk"
=> "Get half fat milk"
irb(main):015:0> t.save
=> true
irb(main):016:0> t
=> #<Task @id=1 @name="Get half fat milk" @completed_at=nil>

The second way 调用 update method. （它会自动将修改保存到数据库）

 irb(main):017:0> t.update(:name => "Get full fat milk")
 => true
 irb(main):019:0> t
 => #<Task @id=1 @name="Get full fat milk" @completed_at=nil>

这些都是 CRUD 操作（actions）

我们还差最后一个 Deleting 操作（using the destroy method ):

irb(main):020:0> t = Task.get(1)
=> #<Task @id=1 @name="Get full fat milk" @completed_at=nil>
irb(main):022:0> t.destroy
=> true

Notice 调用 get method 找到的是id=1的task。This can only be used if you use the primary key to search for it. In this case the primary key is the id, which is 1 for this task.

We will be using this quite often later to get the tasks from unique urls. We can check that it has been deleted by asking to see all the tasks again:

irb(main):023:0> Task.all
=> [#<Task @id=2 @name="Get bananas" @completed_at=nil>]

Now we can see that only our second task to “Get bananas” is still saved in the database.

RESTful urls and CRUD Actions（URL router部分）

The web interface that we will create to interact with our database will be based on the REST principle.
根据REST原则创建的web ui 将会影响前面的db。

这里会使用http verb（动词）：POST、GET、PUT、DELETE；db方面则有对应的CRUD actions。

View a task

对于每个task，最基础的URL可能是这样的：／task／：id（id是task的主键）。无论是read／update／delete都需要浏览器传递http verb。

下面创建一个handler of Views task，打开main.rb，增加代码：

require 'rubygems'
require 'sinatra'
require 'data_mapper'
 
DataMapper.setup(:default,"sqlite3://#{Dir.pwd}/development.db")
 
#定义数据类（model class）
class Task
    include DataMapper::Resource #用include方式包含DM的功能，而没有使用继承
    property :id,Serial
    property :name,String
    property :completed_at,DateTime
end
 
#View a task
get '/task/:id' do
    @task=Task.get(params[:id])
    erb :task
end
 
DataMapper.auto_upgrade! # this must at last line

代码说明：对于新增部分（灰色背景的代码），｛@task=Task.get(params[:id])｝通过URL（／task／：id）其中的id会得到一个task，并放在对象字段@task中。

erb :task 让sinatra显示一个task view（使用erb模板），现在还没有这个模板，所以下面创建此模板文件（./views/task.erb)，模板文件应该放在views目录（这是默认配置决定的），内容：

<h2><%= @task.name%></h2>

task.erb模板只能显示task name内容，如果有一个网站框架的模板就太帅了，现在创建一个名叫layout.erb的模板文件：

<!DOCTYPE html>
<html>
    <head>
        <title>To Do List</title>
        <meta charset="utf-8"/>
    </head>
 
    <body>
        <h1>To Do List</h1>
        <%= yield%><!-- task.erb etc. files entried into here-->
    </body>
</html>

呼～～，现在可以看看你上面都干了什么了，在终端启动主文件吧

ruby main.rb

待启动后，浏览器导航地址http://localhost:4567/task/2，看看有啥！呵呵

Create a new Tasks(using a form)

Create action一般都分成两个handler来处理：

一个显示（输入）表单，名叫“new"；
另一个处理创建task动作。

首先从显示窗体的new handler开始，用户用URL（/task/new）就能显示窗体

这里注意：新代码要放在view handler前面。

#new handler - display input form
get '/task/new' do
    erb :new
end

new views的模板new.erb

<form action="/task/create" method="post">
    <input type="text" name="name" id="name">
    <input type="submit" value="Add TAsk!"/>
</form>