bbcode-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 617d5f1a931e68f19456e55aa4a16ba927ff0d20
+  data.tar.gz: 109ffc1bd60b4ed88ea6ad386d5fd5f1ab2b1a22
+SHA512:
+  metadata.gz: 9ac69f5709d0b35d7d90ba5ded4a5ca82a07c7290fc90219c01fffee99f774ef8eb18b9475e23e6d1d3c2f8efe3a24e593da6c1b363e27f0e9df9e2712b7fe00
+  data.tar.gz: 08babdff7f45fbea834bfc75d126fb91384d298d48ee12ebd7940d2b5c66dff76e41fecd105ec51c4a37f6ea994fafd0b2679886a1947d9070763f749ed61650

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bbcode-rails.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Marcel Müller
+
+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,83 @@
+# BBCode for Rails
+
+`bbcode-rails` is a gem for simple integration of BBCode into your application.
+It does not assume your feature scope and thus does not include every tag out
+there. However, for ease of developement several BBCode tags are included,
+namely:
+
+- Italics `[i] Italics [/i]`
+- Bold `[b] Bold [/b]`
+- Quote `[quote=ID-Name] You can Quote me[/quote]`
+- Image `[img=https://i.imgur.com/V8G8dKg.gif]` or `[img]https://i.imgur.com/V8G8dKg.gif[/img]`
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'bbcode-rails'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bbcode-rails
+
+## Usage
+
+To keep developement simple and easy to understand all tag definitions are found
+in `app/bbcode/`. While it is usually better to have one file per tag, usually
+tags are not big enough to warrant this, so one can also group them. For example
+`styling.rb` could have the simplest tags in it.
+
+### Creating a new tag
+
+You can use the bbcode generator to quickly setup a new tag, simple run
+
+    $ rails generate bbcode tagname
+
+For example if we want to create a bbcode tag to easily link to a user
+
+    $ rails generate bbcode user
+
+This will create `app/bbcode/user_tag.rb`.
+
+```ruby
+#app/bbcode/user.rb
+
+class UserTag < BBCode::Tag
+    name :user
+    on_layout do |args|
+        "TODO: Implement user tag"
+    end
+end
+```
+
+You could now add something like:
+
+```ruby
+#app/bbcode/user.rb
+
+class UserTag < BBCode::Tag
+    name :user, :argument, :no_closing_tag
+    on_layout do |args|
+        user = User.find_by_id(args[1])
+        render partial: 'shared/userquote', locals: user
+    end
+end
+```
+
+Of course, the limitations are your knowledge in ruby and rails :)
+
+
+## Contributing
+
+1. Fork it ( https://github.com/TheNeikos/bbcode-rails/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bbcode-rails.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bbcode-rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "bbcode-rails"
+  spec.version       = BBCode::VERSION
+  spec.authors       = ["Marcel Müller"]
+  spec.email         = ["neikos@neikos.email"]
+
+  spec.summary       = %q{A simple BBCode gem for Rails}
+  spec.description   = %q{A simple and efficient way of managing BBCode in a rails application.}
+  spec.homepage      = "https://github.com/TheNeikos/bbcode-rails"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "bbcode-rails"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/lib/bbcode-rails/railtie.rb

@@ -0,0 +1,4 @@
+module BBCode
+  class Railtie < Rails::Railtie
+  end
+end

data/lib/bbcode-rails/version.rb

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

data/lib/bbcode-rails.rb

@@ -0,0 +1,53 @@
+require "bbcode-rails/version"
+
+module BBCode
+  @@tags = []
+  def self.tags
+    @@tags
+  end
+
+  def self.parse str
+    str = str.dup
+    @@tags.each do |t|
+      str.gsub!(t.regex) { t.block.call($~) }
+    end
+    str
+  end
+
+  class Tag
+    def self.inherited subclass
+      BBCode.tags << subclass
+    end
+
+    def self.name n, *args
+      if args.include? :argument
+        arg = "=(.+?)"
+      end
+      if args.include? :no_closing_tag
+        @regex = /\[#{n.to_s}#{arg}\]/mi
+      else
+        @regex = /\[#{n.to_s}#{arg}\](.+?)\[\/#{n.to_s}\]/mi
+      end
+    end
+
+    def self.on_layout &b
+      @block = b
+    end
+
+    def self.regex
+      @regex
+    end
+
+    def self.block
+      @block
+    end
+  end
+end
+
+class String
+  def to_bbcode
+    BBCode.parse(self)
+  end
+end
+
+require 'bbcode-rails/railtie' if defined?(Rails)

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: bbcode-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marcel Müller
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-04-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A simple and efficient way of managing BBCode in a rails application.
+email:
+- neikos@neikos.email
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bbcode-rails.gemspec
+- bin/console
+- lib/bbcode-rails.rb
+- lib/bbcode-rails/railtie.rb
+- lib/bbcode-rails/version.rb
+homepage: https://github.com/TheNeikos/bbcode-rails
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A simple BBCode gem for Rails
+test_files: []