fredit 0.1.8 → 0.1.9

data/README.md

@@ -27,7 +27,7 @@ You are welcome to fork and add support for Haml and other template
 handlers. 
 
 
-## Why fredit?
+## fredit lowers the barriers to collaboration
 
 On a current Rails project, I needed to delegate responsibility for
 improving the copy, the styling, and the user interface to another
@@ -40,26 +40,56 @@ person. Let's call this person "Chad." Chad:
 * can use a web browser interface to edit files
 
 One option here is to set up a full Rails development environment on
-Chad's computer. But this option is not attractive for several
-reasons. Chad is not familiar with Linux or git. I would have to install
-Ruby, gems, and the RDBMS on Chad's computer for him. I would have to
-teach Chad a lot of things: how to check out the application code from
-the git repository, how to start the Rails app, how to run migrations,
-how to check his changes into the git repository and push them upstream.
-All this work just to get Chad to the point where he can edit the view
-templates and the stylesheets of your Rails app.
+Chad's computer. But this option sucks for several reasons. Chad is not
+very familiar with the command line, git, RVM, Ruby, rake, bundler, or
+you name it. To get Chad started, I would have to install a thousand and
+one dependencies on Chad's computer. I would have to tutor Chad on
+dozens of rails, bundler, gem, rake, git, and other command line
+incantations.  All this just so Chad can tweak the frackin view
+templates and stylesheets. This is madness. And if you want to add
+additional non-Rails people as front-end collaborators, [the King of
+Sparta kicks you into a pit][sparta]. Have fun.
+
+[sparta]:http://www.youtube.com/watch?v=-qR0Uke2XNI
 
 Another option is to integrate a CMS into your Rails app. But in
-addition to being quite heavyweight, this approach is too restrictive when
-you want to give your collaborator as much control over the front-end as
-he or she can handle.
+addition to adding a mass of dependencies and code bloat, this approach
+is too restrictive when you want to give your collaborator as much
+control over the front-end as he or she can handle.
 
-fredit lets a collaborator make significant front-end contributions to a
-Rails application without the hassles of having to set up and run a
-local instance of it. Just run a fredit-enabled instance of your Rails
-app on a server that your collaborator can access through his or her
-browser. This fredit-enabled instance can have its own Rails
-environment, database, and git branch. 
+**fredit helps you empower capable non-Rails programmers to help you on
+the front-end of a Rails app, with less overhead.** 
+
+Just run a fredit-enabled instance of your Rails app on a server that he
+or she can access through a web browser.  This fredit-able instance can
+have its own Rails environment, database, and git branch. You probably
+put a copy of your app on a staging server anyway, so you can use that
+instance for fredit-ing.
+
+## The ideal Ruby templating system is other people
+
+It's becoming less and less sustainable to have Rails programmers serve
+as gatekeepers and bottlenecks through which all markup and source code
+must pass.  We should be searching for ways to allow people with a even
+just little bit of Ruby, HTML, JavaScript, and CSS knowledge to take
+some of the workload off our broad but still finite programming
+shoulders.  
+
+Instead of looking for the next Haml or Slim or Sass, which shaves off
+yet another 0.5 percent of superfluous typing from your template and css
+typing sessions, isn't it better to make it easier for OTHER PEOPLE,
+EVEN NON-RAILS EXPERTS, to write and maintain the view layer for you?
+Who knows, they might even find it fun and educational.
+
+More compact DSLs are not the only way to increase programmer happiness
+and productivity. Another way is to achieve a more productive division
+of labor with those who aren't full-stack web dev ninjas or perhaps not
+even "real" programmers but who are available and willing to help.
+Think [comparative advantage][comparative] from your college economics
+class. We need to apply this idea more to software development.  Let's
+lower the "collaboration barrier" to reap further gains in productivity.
+
+[comparative]:http://www.econlib.org/library/Topics/Details/comparativeadvantage.html
 
 
 ## Install and setup
@@ -81,14 +111,15 @@ and then run `RAILS_ENV=staging bundle install`, adjusting the
 `RAILS_ENV` to your target environment.
 
 To run your Rails app with fredit, just start it in the Rails
-environment Gemfile group you put the fredit gem in. When you hit the
-app in the browser, you should see the injected view template links and
-be able to click through them to fredit's source code editor.
+environment corresponding to the Gemfile group you put fredit in. When
+you hit the app in the browser, you should see the injected view
+template links and be able to click through them to fredit's source code
+editor.
 
 
-## fredit with git 
+## Use fredit with git 
 
-fredit assumes that the Rails instance it is running on is a cloned git
+fredit assumes that the Rails instance it is running on is a git
 repository. **It also assumes that you have set the current branch of
 this git repository to the one you want your collaborator's changes
 committed to.**
@@ -109,17 +140,17 @@ upstream repository, run a CI build server, etc.
 
 ## Security
 
-fredit has rudimentary security features. fredit will not allow any user
-to use the fredit web interface to edit a file above or outside the
-Rails application root directory of that Rails instance.  But this still
-leaves things like database.yml configurations accessible to the fredit
-editor. Anyone with access to the fredit editing interface will have the
-power to run arbitrary SQL on your environment's database.
+Currently, fredit has only rudimentary security features. fredit will
+not allow any user to use the fredit web interface to edit a file above
+or outside the Rails application root directory of that Rails instance.
+But this still leaves things like database.yml configurations accessible
+to the fredit editor. Anyone with access to the fredit editing interface
+will have the power to run arbitrary SQL on your environment's database.
 
 So please take additional precautions to make sure that your
-fredit-enabled Rails instance is not accessible by hostile strangers.
-At a minimum, use Apache Basic Authentication or the like to restrict
-access to this entire Rails instance. 
+fredit-enabled Rails instance can't be accessed by hostile strangers.
+At a minimum, use Basic Authentication or the like to restrict access to
+this entire Rails instance. 
 
 It's probably not a good idea to run a fredit-enabled Rails app on a
 server with important stuff on it. Use a scratch staging server.
@@ -129,7 +160,8 @@ server with important stuff on it. Use a scratch staging server.
 
 Feel free to fork and take this simple idea wherever you want to. The
 current version of this project is really just a quick and dirty
-implementation that I needed pronto.
+implementation that I needed pronto. Pull requests are very welcome.
+
 
 
 ## License

data/app/controllers/fredit_controller.rb

@@ -31,6 +31,7 @@ class FreditController < ::ApplicationController
     if session[:commit_author].blank?
       flash.now[:notice] = "Edited By must not be blank"
       @source = params[:source]
+      load_git_log
       render :action => 'show'
       return
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fredit
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-25 00:00:00.000000000Z
+date: 2011-10-27 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git
-  requirement: &70153551354840 !ruby/object:Gem::Requirement
+  requirement: &70199512506440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70153551354840
+  version_requirements: *70199512506440
 description: Edit the front end of Rails apps through the browser.
 email:
 - dhchoi@gmail.com
@@ -56,7 +56,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4259262550981050776
+      hash: 1023881741045697263
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -65,7 +65,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4259262550981050776
+      hash: 1023881741045697263
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.6