bootstrap_progressbar 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 292e340e27434f91a96c7aaf5ef7d1817d719908
+  data.tar.gz: e4d7e48b911dd3da71eb6a90ec019fe1583d4168
+SHA512:
+  metadata.gz: 19b00b4f120da9d3244cf71e42b667b1fde2a64a7e48a6638719d264031346693f3d321da49c62552e9ebb8b435815b4a79f75cc0e0bf1842c0912d0b5768d1a
+  data.tar.gz: 20d571c9f27b186755305c4df0ec109ab24a496aec63f2be8f5528aea80135c3715405683938e04c192c2f3b08ed44832a5bad20f82d0d08ae46de2724a5a85c

data/README.md

@@ -0,0 +1,18 @@
+rails-bootstrap-progressbar
+===========================
+
+still under construction...
+
+## description
+
+Bootstrap_progressbar will make it super easy to create beautiful-looking progress bar in rails using Bootstrap 3
+
+## run the test
+
+To init environment:
+
+    $ cd test/dummy && bundle exec rake RAILS_ENV=test && cd ../../
+
+Then you can:
+
+    $ bundle exec rake test

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+# encoding: UTF-8
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+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/lib/bootstrap_progressbar/helper.rb

@@ -0,0 +1,78 @@
+module BootstrapProgressbar::Helper
+  module Private
+
+    def self.check_percent(percent)
+      if percent < 0 || percent > 1
+        throw ArgumentError.new('the percent(first argument) should between 0 to 1')
+      end
+    end
+
+    # generate a bootstrap progress-bar with a percent and custom options
+    # Params:
+    # +percent+:: +Fixnum+ between 0 to 1.00
+    # +options+::
+    # alternative: ['success', 'danger', 'warning', 'info']
+    # striped: boolean
+    # active: boolean
+    # label: boolean
+    # class: a string contained more given class
+    def self.only_progress_bar(percent, options = {})
+      percent *= 100
+      percent = percent.to_i
+
+      case options[:alternative]
+        when 'success'
+        alternative = 'progress-bar-success'
+        when 'danger'
+        alternative = 'progress-bar-danger'
+        when 'warning'
+        alternative = 'progress-bar-warning'
+        when 'info'
+        alternative = 'progress-bar-info'
+        else
+        alternative = ''
+      end
+
+      if options[:active]
+        striped = "progress-bar-striped active"
+      elsif options[:striped]
+        striped = "progress-bar-striped"
+      else
+        striped = ""
+      end
+
+      clazz = options[:class] if options[:class]
+
+      unless options[:label]
+        percent_and_label = "<span class='sr-only'>#{percent}%</span>"
+      else
+        percent_and_label = "#{percent}%"
+      end
+
+      "<div class='#{[clazz, 'progress-bar', alternative, striped].join(' ').strip()}' role='progressbar' aria-valuenow='#{percent}' aria-valuemin='0' aria-valuemax='100' style='width: #{percent}%'>#{percent_and_label}</div>"
+    end
+
+  end
+
+  include Private
+
+  # generate progress and progress-bar inside
+  def progress_bar(percent, options = {})
+    Private.check_percent(percent)
+
+    if options[:class]
+      clazz = options[:class] 
+      options[:class] = ""
+    end
+    progress_bar = Private.only_progress_bar(percent, options)
+
+    raw "<div class='#{[clazz, 'progress'].join(' ').strip()}'>#{progress_bar}</div>"
+  end
+
+  # only generate the progress-bar
+  def simple_progress_bar(percent, options = {})
+    Private.check_percent(percent)
+    raw Private.only_progress_bar(percent, options)
+  end
+
+end

data/lib/bootstrap_progressbar/version.rb

@@ -0,0 +1,3 @@
+module BootstrapProgressbar
+  VERSION = "0.1.0"
+end

data/lib/bootstrap_progressbar.rb

@@ -0,0 +1,10 @@
+require 'bootstrap_progressbar/helper'
+
+module BootstrapProgressbar
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+
+ActionView::Base.send :include, BootstrapProgressbar::Helper

data/test/bootstrap_progressbar_test.rb

@@ -0,0 +1,73 @@
+require 'test_helper'
+
+class BootstrapProgressbarTest < ActionView::TestCase
+  include BootstrapProgressbar::Helper
+
+  test "check percent: the percent should between 0 to 1" do
+    begin
+      progress_bar(2)
+    rescue ArgumentError => e
+      assert_equal 'uncaught throw #<ArgumentError: the percent(first argument) should between 0 to 1>', e.message
+    end
+  end
+
+  test "generate progress bar ok" do
+    result = progress_bar(0.5)
+    assert_equal "<div class='progress'><div class='progress-bar' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "generate progress bar with label" do
+    result = progress_bar(0.5, label: true)
+    assert_equal "<div class='progress'><div class='progress-bar' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'>50%</div></div>", result
+  end
+
+  test "generate progress bar with alternative: success" do
+    result = progress_bar(0.5, alternative: 'success')
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-success' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "generate progress bar with alternative: info" do
+    result = progress_bar(0.5, alternative: 'info')
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-info' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "generate progress bar with alternative: danger" do
+    result = progress_bar(0.5, alternative: 'danger')
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-danger' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "generate progress bar with alternative: warning" do
+    result = progress_bar(0.5, alternative: 'warning')
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-warning' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "support striped progress bar" do
+    result = progress_bar(0.5, alternative: 'success', striped: true)
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-success progress-bar-striped' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "support active, striped progress bar" do
+    # set active true will also set striped true
+    result = progress_bar(0.5, alternative: 'success', active: true)
+    assert_equal "<div class='progress'><div class='progress-bar progress-bar-success progress-bar-striped active' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  test "support adding extra class to progress" do
+    # you can add min-width css rule for class more
+    result = progress_bar(0.5, class: 'more')
+    assert_equal "<div class='more progress'><div class='progress-bar' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div></div>", result
+  end
+
+  # simple_progress_bar support all options for progress_bar
+  test "use simple_progress_bar to generate simple progress-bar" do
+    # so that stacked progress bars can be supported
+    result = simple_progress_bar(0.5)
+    assert_equal "<div class='progress-bar' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div>", result
+  end
+
+  test "support adding extra class to progress-bar" do
+    result = simple_progress_bar(0.5, class: 'more')
+    assert_equal "<div class='more progress-bar' role='progressbar' aria-valuenow='50' aria-valuemin='0' aria-valuemax='100' style='width: 50%'><span class='sr-only'>50%</span></div>", result
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+
+require File.expand_path("../dummy/config/environment.rb",  __FILE__)
+require "rails/test_help"

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: bootstrap_progressbar
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- spacewander
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: bootstrap_progressbar makes it super easy to create beautiful-looking
+  progress bar in rails using Bootstrap 3
+email:
+- spacewanderlzx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/bootstrap_progressbar.rb
+- lib/bootstrap_progressbar/helper.rb
+- lib/bootstrap_progressbar/version.rb
+- test/bootstrap_progressbar_test.rb
+- test/test_helper.rb
+homepage: https://github.com/spacewander/rails-bootstrap-progressbar
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: build Bootstrap 3 progress bar quickly in rails
+test_files:
+- test/test_helper.rb
+- test/bootstrap_progressbar_test.rb