gnarus_activity 1.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2012 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+GnarusActivity
+==============
+
+This project rocks and uses MIT-LICENSE. Install
+
+```
+gem install gnarus_activity
+```
+
+Configuring a new project
+=========================
+
+```
+gnarus activity my_project
+```
+
+You will be prompted about adding <code>devise</code> into your application, then it is up
+to you accept it (if you want authentication in your exercises) or not.
+
+Default execution
+=================
+
+The default index.html.erb displays a solution field where the user types his response.
+
+Due to the invocation of:
+
+```javascript
+gnarus.attemptForm({ solution : function() {},
+					 callback : function(result) {},
+					 gnarusUri : '',
+					 allowsSkip : true }).setup();
+```
+
+When clicking in the try button, the solution function is invoked. It should return
+the response to send to the rails server for processing.
+
+### Processing the user response
+
+The method <code>ActivityProcessor#process(attempt, params)</code> is invoked.
+It should return an Execution with the field succeded=true or false.
+Example:
+
+```ruby
+class ActivityProcessor
+  def self.process(attempt, params)
+	isCorrect = params[:solution]=="42"
+    attempt.executions.create (
+      solution: params[:solution],
+      suceeded: isCorrect
+	  )
+  end
+end
+```
+
+The default implementation of this method *always* return suceeded = true.
+
+### Showing the response to the user
+
+After processing, the callback is invoked with the result.succeeded.
+
+(1) If it is false, you should display an error message.
+(2) If it is true, display what you want. In this case, the page will be AUTOMATICALLY
+redirected to the gnarusUri. The exercise finishes
+
+
+TODO
+====
+
+- the SOLUTION member should be renamed to something more meaningful (response)
+- generated template should add gnarus_activity version to gemfile
+- update method UPDATE from exercise to be safe
+- we are using the index file to show an attempt, nasty. a GET to a better named method
+- automatic reload from ActivityProcessor

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'GnarusActivity'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/assets/stylesheets/gnarus_activity/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+*/

data/app/controllers/gnarus_activity/application_controller.rb

@@ -0,0 +1,7 @@
+module GnarusActivity
+  class ApplicationController < ActionController::Base
+    def after_sign_in_path_for(resource)
+        return root_path
+    end
+  end
+end

data/app/controllers/gnarus_activity/attempts_controller.rb

@@ -0,0 +1,13 @@
+module GnarusActivity
+  class AttemptsController < ApplicationController
+  
+    skip_before_filter :verify_authenticity_token
+
+    def index
+      exercise = Exercise.find(params[:exercise_id])
+      @attempt = exercise.attempts.create(params[:attempt])
+      @attempt.save
+    end
+
+  end
+end

data/app/controllers/gnarus_activity/executions_controller.rb

@@ -0,0 +1,14 @@
+module GnarusActivity
+  class ExecutionsController < ApplicationController
+  
+    skip_before_filter :verify_authenticity_token
+
+    def create
+      @attempt = Attempt.find params[:attempt_id]
+      execution = ::ActivityProcessor.process @attempt, params
+      execution.save
+      render :json => execution.to_json(:includes => :attempt)
+    end
+
+  end
+end

data/app/controllers/gnarus_activity/exercises_controller.rb

@@ -0,0 +1,55 @@
+module GnarusActivity
+  class ExercisesController < ApplicationController
+  
+    before_filter :authenticate_user! if defined?(Devise)
+  
+    def index
+      @exercises = Exercise.all.select{|e| e.author.id == current_user.id}
+    end
+
+    def show
+      @exercise = Exercise.find(params[:id])
+    end
+
+    def new
+      @exercise = Exercise.new
+    end
+
+    # GET /exercises/1/edit
+    def edit
+      @exercise = Exercise.find(params[:id])
+    end
+
+    def create
+      @exercise = Exercise.new(params[:exercise])
+      @exercise.author = current_user if defined?(Devise)
+
+        if @exercise.save
+          redirect_to @exercise, notice: 'Exercise was successfully created.'
+        else
+          render action: "new"
+        end
+    end
+
+    def update
+      @exercise = Exercise.find(params[:id])
+      if defined?(Devise) && @exercise.author == current_user 
+        params[:exercise].delete :author_id
+        @exercise.update_attributes(params[:exercise])
+      end
+
+      redirect_to @exercise, notice: 'Exercise was successfully updated.'
+    end
+
+    # DELETE /exercises/1
+    # DELETE /exercises/1.json
+    def destroy
+      @exercise = Exercise.find(params[:id])
+      if defined?(Devise) && @exercise.author == current_user 
+        @exercise.destroy
+      end
+
+      redirect_to exercises_url
+    end
+  end
+end

data/app/controllers/gnarus_activity/status_controller.rb

@@ -0,0 +1,11 @@
+module GnarusActivity
+  class StatusController < ApplicationController
+  
+    skip_before_filter :verify_authenticity_token
+
+    def ping
+      render :json => {:status => "alive"}
+    end
+
+  end
+end

data/app/helpers/gnarus_activity/application_helper.rb

@@ -0,0 +1,4 @@
+module GnarusActivity
+  module ApplicationHelper
+  end
+end

data/app/models/activity_processor.rb

@@ -0,0 +1,5 @@
+class ActivityProcessor
+  def self.process(attempt, params)
+    attempt.executions.create :solution => params[:solution], :suceeded => true
+  end
+end

data/app/models/gnarus_activity/attempt.rb

@@ -0,0 +1,15 @@
+module GnarusActivity
+  class Attempt < ActiveRecord::Base
+    belongs_to :exercise
+    has_many :executions
+    attr_accessible :return_uri, :author_id
+
+    def full_return_uri
+       (return_uri || "") + "?answer=" + (solution || "")
+    end
+
+    def process(params)
+      executions.create :solution => params[:solution], :suceeded => params[:suceeded]
+    end
+  end
+end

data/app/models/gnarus_activity/execution.rb

@@ -0,0 +1,6 @@
+module GnarusActivity
+  class Execution < ActiveRecord::Base
+    attr_accessible :attempt, :solution, :suceeded
+    belongs_to :attempt
+  end
+end

data/app/models/gnarus_activity/exercise.rb

@@ -0,0 +1,7 @@
+module GnarusActivity
+  class Exercise < ActiveRecord::Base
+    attr_accessible :author_id, :content, :title
+    has_many :attempts
+    belongs_to :author, :class_name => User if defined?(User)
+  end
+end

data/app/views/gnarus_activity/exercises/_form.html.erb

@@ -0,0 +1,27 @@
+<%= form_for(@exercise) do |f| %>
+  <% if @exercise.errors.any? %>
+    <div id="error_explanation">
+      <h2><%= pluralize(@exercise.errors.count, "error") %> prohibited this exercise from being saved:</h2>
+
+      <ul>
+      <% @exercise.errors.full_messages.each do |msg| %>
+        <li><%= msg %></li>
+      <% end %>
+      </ul>
+    </div>
+  <% end %>
+
+  <div class="field">
+    <%= f.label :title %><br />
+    <%= f.text_area :title %>
+  </div>
+
+  <div class="field">
+    <%= f.label :content %><br />
+    <%= f.text_area :content %>
+  </div>
+	<%= render :partial => "my_fields", :locals => { :f => f} %>
+  <div class="actions">
+    <%= f.submit %>
+  </div>
+<% end %>

data/app/views/gnarus_activity/exercises/edit.html.erb

@@ -0,0 +1,6 @@
+<h1>Editing exercise</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Show', @exercise %> |
+<%= link_to 'Back', exercises_path %>

data/app/views/gnarus_activity/exercises/index.html.erb

@@ -0,0 +1,25 @@
+<h1>Listing exercises</h1>
+
+<table>
+  <tr>
+    <th>Title</th>
+    <th>Content</th>
+    <th></th>
+    <th></th>
+    <th></th>
+  </tr>
+
+<% @exercises.each do |exercise| %>
+  <tr>
+    <td><%= exercise.title %></td>
+    <td><%= exercise.content %></td>
+    <td><%= link_to 'Show', exercise %></td>
+    <td><%= link_to 'Edit', edit_exercise_path(exercise) %></td>
+    <td><%= link_to 'Destroy', exercise, confirm: 'Are you sure?', method: :delete %></td>
+  </tr>
+<% end %>
+</table>
+
+<br />
+
+<%= link_to 'New Exercise', new_exercise_path %>

data/app/views/gnarus_activity/exercises/new.html.erb

@@ -0,0 +1,5 @@
+<h1>New exercise</h1>
+
+<%= render 'form' %>
+
+<%= link_to 'Back', exercises_path %>

data/app/views/gnarus_activity/exercises/show.html.erb

@@ -0,0 +1,15 @@
+<p id="notice"><%= notice %></p>
+
+<p>
+  <b>Title:</b>
+  <%= @exercise.title %>
+</p>
+
+<p>
+  <b>Content:</b>
+  <%= @exercise.content %>
+</p>
+
+<a href="/exercises/<%= @exercise.id%>/attempts">Preview</a> | 
+<%= link_to 'Edit', edit_exercise_path(@exercise) %> |
+<%= link_to 'Back', exercises_path %>

data/app/views/layouts/gnarus_activity/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Gnarus Activity</title>
+  <%= stylesheet_link_tag    "gnarus_activity/application", :media => "all" %>
+  <%= javascript_include_tag "gnarus_activity/application" %>
+  <%= javascript_include_tag "application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/bin/gnarus

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding:utf-8
+template = File.expand_path("../../lib/activity_template.rb", __FILE__)
+
+puts ":::::::::::::::::::::::"
+puts "gnarus activity utility"
+puts ":::::::::::::::::::::::\n\n"
+
+if !ARGV[0]
+  puts "ooops, what do you want me to do?"
+  puts "did you want to create an activity?"
+  puts "    if so: gnarus activity [project]\n\n"
+  exit(0)
+end
+
+command = ARGV[0]
+option = ARGV[1]
+
+if command == "activity"
+  if !option
+    puts "you need a project name, try: gnarus activity [project]\n\n"
+    exit(0)
+  end
+  execution = "rails new #{option} -m #{template}"
+  puts "executando: #{execution}"
+  system(execution)
+  exit(0)
+end
+
+puts "i don't know any [#{command}]"
+puts "Y U NO TELL ME WHAT TO DO?!?!?\n\n"
+exit(0)