-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
AGPL, copyright, and assignment documents
- Loading branch information
Showing
9 changed files
with
826 additions
and
254 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
This entire codebase is copyright (2011) Sai d/b/a Make Your Laws and released under the GNU Affero General Public License (/LICENSE), with the exception of external libraries (primarily under /vendor or /lib), which are copyright of their respective owners, whose licenses are listed together with their code. | ||
|
||
The copyright to this codebase will be transferred to Make Your Laws, the nonprofit corporation, as soon as that entity exists. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,256 +1,4 @@ | ||
== Welcome to Rails | ||
MakeYourLaws.org aims to eventually be an international scale replacement of legislatures, by enabling citizens to participate in online direct democracy (with transferrable proxies). It will bootstrap through existing legal mechanisms for direct action with teeth: ballot propositions and grassroots campaign financing. | ||
|
||
Rails is a web-application framework that includes everything needed to create | ||
database-backed web applications according to the Model-View-Control pattern. | ||
This software is in very early alpha stage and not yet usable. | ||
|
||
This pattern splits the view (also called the presentation) into "dumb" | ||
templates that are primarily responsible for inserting pre-built data in between | ||
HTML tags. The model contains the "smart" domain objects (such as Account, | ||
Product, Person, Post) that holds all the business logic and knows how to | ||
persist themselves to a database. The controller handles the incoming requests | ||
(such as Save New Account, Update Product, Show Post) by manipulating the model | ||
and directing data to the view. | ||
|
||
In Rails, the model is handled by what's called an object-relational mapping | ||
layer entitled Active Record. This layer allows you to present the data from | ||
database rows as objects and embellish these data objects with business logic | ||
methods. You can read more about Active Record in | ||
link:files/vendor/rails/activerecord/README.html. | ||
|
||
The controller and view are handled by the Action Pack, which handles both | ||
layers by its two parts: Action View and Action Controller. These two layers | ||
are bundled in a single package due to their heavy interdependence. This is | ||
unlike the relationship between the Active Record and Action Pack that is much | ||
more separate. Each of these packages can be used independently outside of | ||
Rails. You can read more about Action Pack in | ||
link:files/vendor/rails/actionpack/README.html. | ||
|
||
|
||
== Getting Started | ||
|
||
1. At the command prompt, create a new Rails application: | ||
<tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name) | ||
|
||
2. Change directory to <tt>myapp</tt> and start the web server: | ||
<tt>cd myapp; rails server</tt> (run with --help for options) | ||
|
||
3. Go to http://localhost:3000/ and you'll see: | ||
"Welcome aboard: You're riding Ruby on Rails!" | ||
|
||
4. Follow the guidelines to start developing your application. You can find | ||
the following resources handy: | ||
|
||
* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html | ||
* Ruby on Rails Tutorial Book: http://www.railstutorial.org/ | ||
|
||
|
||
== Debugging Rails | ||
|
||
Sometimes your application goes wrong. Fortunately there are a lot of tools that | ||
will help you debug it and get it back on the rails. | ||
|
||
First area to check is the application log files. Have "tail -f" commands | ||
running on the server.log and development.log. Rails will automatically display | ||
debugging and runtime information to these files. Debugging info will also be | ||
shown in the browser on requests from 127.0.0.1. | ||
|
||
You can also log your own messages directly into the log file from your code | ||
using the Ruby logger class from inside your controllers. Example: | ||
|
||
class WeblogController < ActionController::Base | ||
def destroy | ||
@weblog = Weblog.find(params[:id]) | ||
@weblog.destroy | ||
logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!") | ||
end | ||
end | ||
|
||
The result will be a message in your log file along the lines of: | ||
|
||
Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1! | ||
|
||
More information on how to use the logger is at http://www.ruby-doc.org/core/ | ||
|
||
Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are | ||
several books available online as well: | ||
|
||
* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe) | ||
* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide) | ||
|
||
These two books will bring you up to speed on the Ruby language and also on | ||
programming in general. | ||
|
||
|
||
== Debugger | ||
|
||
Debugger support is available through the debugger command when you start your | ||
Mongrel or WEBrick server with --debugger. This means that you can break out of | ||
execution at any point in the code, investigate and change the model, and then, | ||
resume execution! You need to install ruby-debug to run the server in debugging | ||
mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example: | ||
|
||
class WeblogController < ActionController::Base | ||
def index | ||
@posts = Post.find(:all) | ||
debugger | ||
end | ||
end | ||
|
||
So the controller will accept the action, run the first line, then present you | ||
with a IRB prompt in the server window. Here you can do things like: | ||
|
||
>> @posts.inspect | ||
=> "[#<Post:0x14a6be8 | ||
@attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>, | ||
#<Post:0x14a6620 | ||
@attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]" | ||
>> @posts.first.title = "hello from a debugger" | ||
=> "hello from a debugger" | ||
|
||
...and even better, you can examine how your runtime objects actually work: | ||
|
||
>> f = @posts.first | ||
=> #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}> | ||
>> f. | ||
Display all 152 possibilities? (y or n) | ||
|
||
Finally, when you're ready to resume execution, you can enter "cont". | ||
|
||
|
||
== Console | ||
|
||
The console is a Ruby shell, which allows you to interact with your | ||
application's domain model. Here you'll have all parts of the application | ||
configured, just like it is when the application is running. You can inspect | ||
domain models, change values, and save to the database. Starting the script | ||
without arguments will launch it in the development environment. | ||
|
||
To start the console, run <tt>rails console</tt> from the application | ||
directory. | ||
|
||
Options: | ||
|
||
* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications | ||
made to the database. | ||
* Passing an environment name as an argument will load the corresponding | ||
environment. Example: <tt>rails console production</tt>. | ||
|
||
To reload your controllers and models after launching the console run | ||
<tt>reload!</tt> | ||
|
||
More information about irb can be found at: | ||
link:http://www.rubycentral.com/pickaxe/irb.html | ||
|
||
|
||
== dbconsole | ||
|
||
You can go to the command line of your database directly through <tt>rails | ||
dbconsole</tt>. You would be connected to the database with the credentials | ||
defined in database.yml. Starting the script without arguments will connect you | ||
to the development database. Passing an argument will connect you to a different | ||
database, like <tt>rails dbconsole production</tt>. Currently works for MySQL, | ||
PostgreSQL and SQLite 3. | ||
|
||
== Description of Contents | ||
|
||
The default directory structure of a generated Ruby on Rails application: | ||
|
||
|-- app | ||
| |-- controllers | ||
| |-- helpers | ||
| |-- mailers | ||
| |-- models | ||
| `-- views | ||
| `-- layouts | ||
|-- config | ||
| |-- environments | ||
| |-- initializers | ||
| `-- locales | ||
|-- db | ||
|-- doc | ||
|-- lib | ||
| `-- tasks | ||
|-- log | ||
|-- public | ||
| |-- images | ||
| |-- javascripts | ||
| `-- stylesheets | ||
|-- script | ||
|-- test | ||
| |-- fixtures | ||
| |-- functional | ||
| |-- integration | ||
| |-- performance | ||
| `-- unit | ||
|-- tmp | ||
| |-- cache | ||
| |-- pids | ||
| |-- sessions | ||
| `-- sockets | ||
`-- vendor | ||
`-- plugins | ||
|
||
app | ||
Holds all the code that's specific to this particular application. | ||
|
||
app/controllers | ||
Holds controllers that should be named like weblogs_controller.rb for | ||
automated URL mapping. All controllers should descend from | ||
ApplicationController which itself descends from ActionController::Base. | ||
|
||
app/models | ||
Holds models that should be named like post.rb. Models descend from | ||
ActiveRecord::Base by default. | ||
|
||
app/views | ||
Holds the template files for the view that should be named like | ||
weblogs/index.html.erb for the WeblogsController#index action. All views use | ||
eRuby syntax by default. | ||
|
||
app/views/layouts | ||
Holds the template files for layouts to be used with views. This models the | ||
common header/footer method of wrapping views. In your views, define a layout | ||
using the <tt>layout :default</tt> and create a file named default.html.erb. | ||
Inside default.html.erb, call <% yield %> to render the view using this | ||
layout. | ||
|
||
app/helpers | ||
Holds view helpers that should be named like weblogs_helper.rb. These are | ||
generated for you automatically when using generators for controllers. | ||
Helpers can be used to wrap functionality for your views into methods. | ||
|
||
config | ||
Configuration files for the Rails environment, the routing map, the database, | ||
and other dependencies. | ||
|
||
db | ||
Contains the database schema in schema.rb. db/migrate contains all the | ||
sequence of Migrations for your schema. | ||
|
||
doc | ||
This directory is where your application documentation will be stored when | ||
generated using <tt>rake doc:app</tt> | ||
|
||
lib | ||
Application specific libraries. Basically, any kind of custom code that | ||
doesn't belong under controllers, models, or helpers. This directory is in | ||
the load path. | ||
|
||
public | ||
The directory available for the web server. Contains subdirectories for | ||
images, stylesheets, and javascripts. Also contains the dispatchers and the | ||
default HTML files. This should be set as the DOCUMENT_ROOT of your web | ||
server. | ||
|
||
script | ||
Helper scripts for automation and generation. | ||
|
||
test | ||
Unit and functional tests along with fixtures. When using the rails generate | ||
command, template test files will be generated for you and placed in this | ||
directory. | ||
|
||
vendor | ||
External libraries that the application depends on. Also includes the plugins | ||
subdirectory. If the app has frozen rails, those gems also go here, under | ||
vendor/rails/. This directory is in the load path. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
28Nov11: Basic Rails skeleton project w/ text; AGPL, copyright, and assignment documents. -- Sai <makeyourlaws@saizai.com>; website text coauthored w/ Paula Rizzuto & Stutter. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
COPYRIGHT ASSIGNMENT | ||
|
||
For good and valuable consideration, receipt of which I acknowledge, I, [[YOUR FULL LEGAL NAME]] aka [[YOUR GITHUB ACCOUNT NAME]], hereby transfer to Make Your Laws ("MYL") my entire right, title, and interest (including all rights under copyright) in my changes and enhancements to the Make Your Laws project, subject to the conditions below. These changes and enhancements are herein called the "Work." The work hereby assigned shall also include any future revisions of these changes and enhancements hereafter made by me. | ||
|
||
MYL grants me permanent, non-exclusive rights to use the Work (i.e. my changes and enhancements, not the program which I enhanced) as I see fit; the MYL's rights shall otherwise continue unchanged. | ||
|
||
For the purposes of this contract, a work "based on the Work" means any work that in whole or in part incorporates or is derived from all or part of the Work. | ||
|
||
MYL promises that all distribution of the Work, or of any work "based on the Work," that takes place under the control of MYL or its assignees, shall be on terms that explicitly and perpetually permit anyone possessing a copy of the work to which the terms apply, and possessing accurate notice of these terms, to redistribute copies of the work to anyone on the same terms. These terms shall not restrict which members of the public copies may be distributed to. These terms shall not require a member of the public to pay any royalty to MYL or to anyone else for any permitted use of the work they apply to, or to communicate with MYL or its agents in any way either when redistribution is performed or on any other occasion. | ||
|
||
MYL promises that any program "based on the Work" offered to the public by MYL or its assignees shall be offered in the form of machine-readable source code, in addition to any other forms of MYL's choosing. However, MYL is free to choose at its convenience the media of distribution for machine-readable source code. | ||
|
||
MYL promises to make available to me without any request required, as with any member of the public, an online copy of any or all of the works "based on the Work" that it offers to the public or that it has offered within the past six months, or that it distributed for the first time within the past six months. For works that are programs, the machine-readable source code shall be included. | ||
|
||
I hereby agree that if I have or acquire hereafter any patent or interface copyright or other intellectual property interest dominating the program enhanced by the Work (or use of that program), such dominating interest will not be used to undermine the effect of this assignment, i.e. MYL and the general public will be licensed to use, in that program and its derivative works, without royalty or limitation, the subject matter of the dominating interest. This license provision will be binding on my heirs, assignees, or other successors to the dominating interest, as well as on me. | ||
|
||
I hereby represent and warrant that I am the sole copyright holder for the Work and that I have the right and power to enter into this contract. | ||
|
||
I hereby indemnify and hold harmless MYL, its officers, employees, and agents against any and all claims, actions or damages (including attorney's reasonable fees) asserted by or paid to any party on account of a breach or alleged breach of the foregoing warranty. I make no other express or implied warranty (including without limitation, in this disclaimer of warranty, any warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE). | ||
|
||
Agreed: [[FULL NAME]], [[FULL DATE in form DD MONTH YYYY]] | ||
|
||
Signed using my PGP key, [[PGP KEY ID #]]. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
COPYRIGHT ASSIGNMENT | ||
|
||
For good and valuable consideration, receipt of which I acknowledge, I, [[YOUR FULL LEGAL NAME]] aka [[YOUR GITHUB ACCOUNT NAME]], hereby transfer to Make Your Laws ("MYL") my entire right, title, and interest (including all rights under copyright) in my changes and enhancements to the Make Your Laws project, subject to the conditions below. These changes and enhancements are herein called the "Work." The work hereby assigned shall also include any future revisions of these changes and enhancements hereafter made by me. | ||
|
||
MYL grants me permanent, non-exclusive rights to use the Work (i.e. my changes and enhancements, not the program which I enhanced) as I see fit; the MYL's rights shall otherwise continue unchanged. | ||
|
||
For the purposes of this contract, a work "based on the Work" means any work that in whole or in part incorporates or is derived from all or part of the Work. | ||
|
||
MYL promises that all distribution of the Work, or of any work "based on the Work," that takes place under the control of MYL or its assignees, shall be on terms that explicitly and perpetually permit anyone possessing a copy of the work to which the terms apply, and possessing accurate notice of these terms, to redistribute copies of the work to anyone on the same terms. These terms shall not restrict which members of the public copies may be distributed to. These terms shall not require a member of the public to pay any royalty to MYL or to anyone else for any permitted use of the work they apply to, or to communicate with MYL or its agents in any way either when redistribution is performed or on any other occasion. | ||
|
||
MYL promises that any program "based on the Work" offered to the public by MYL or its assignees shall be offered in the form of machine-readable source code, in addition to any other forms of MYL's choosing. However, MYL is free to choose at its convenience the media of distribution for machine-readable source code. | ||
|
||
MYL promises to make available to me without any request required, as with any member of the public, an online copy of any or all of the works "based on the Work" that it offers to the public or that it has offered within the past six months, or that it distributed for the first time within the past six months. For works that are programs, the machine-readable source code shall be included. | ||
|
||
I hereby agree that if I have or acquire hereafter any patent or interface copyright or other intellectual property interest dominating the program enhanced by the Work (or use of that program), such dominating interest will not be used to undermine the effect of this assignment, i.e. MYL and the general public will be licensed to use, in that program and its derivative works, without royalty or limitation, the subject matter of the dominating interest. This license provision will be binding on my heirs, assignees, or other successors to the dominating interest, as well as on me. | ||
|
||
I hereby represent and warrant that I and [[EMPLOYERS' FULL LEGAL NAMES]] are the sole copyright holders for the Work and that I have the right and power to enter into this contract. | ||
|
||
I hereby indemnify and hold harmless MYL, its officers, employees, and agents against any and all claims, actions or damages (including attorney's reasonable fees) asserted by or paid to any party on account of a breach or alleged breach of the foregoing warranty. I make no other express or implied warranty (including without limitation, in this disclaimer of warranty, any warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE). | ||
|
||
Agreed: [[FULL NAME]], [[FULL DATE in form DD MONTH YYYY]] | ||
|
||
|
||
EMPLOYER RELEASE | ||
|
||
[[EMPLOYER'S FULL LEGAL NAME]] hereby disclaims all copyright interest in the changes and enhancements made by [[YOUR NAME]] to the Make Your Laws Project, also including any future revisions of these changes and enhancements. | ||
|
||
[[EMPLOYER'S FULL LEGAL NAME]] affirms that it has no other intellectual property interest that would undermine this release, or the use of the Program, and will do nothing to undermine it in the future. | ||
|
||
I, [[YOUR NAME]], hereby represent and warrant that I have received the above written authorization on [[FULL DATE, MM MONTH YYYY]] from [[EMPLOYER'S REPRESENTATIVE]], [[REPRESENTATIVE'S TITLE]] at [[EMPLOYER'S FULL LEGAL NAME]], who is authorized to sign contracts and/or licensing agreements on its behalf. | ||
|
||
|
||
Signed using my PGP key, [[PGP KEY ID #]]. |
Oops, something went wrong.