Skip to content

Commit

Permalink
Init gem
Browse files Browse the repository at this point in the history
  • Loading branch information
owaiswiz committed Nov 29, 2019
0 parents commit c8ec39a
Show file tree
Hide file tree
Showing 13 changed files with 158 additions and 0 deletions.
8 changes: 8 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
/.bundle/
/.yardoc
/_yardoc/
/coverage/
/doc/
/pkg/
/spec/reports/
/tmp/
7 changes: 7 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
sudo: false
language: ruby
cache: bundler
rvm:
- 2.6.5
before_install: gem install bundler -v 1.17.3
6 changes: 6 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
source "https://rubygems.org"

git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }

# Specify your gem's dependencies in kawaiitext.gemspec
gemspec
39 changes: 39 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# KawaiiText

## What is this ?
Its a ruby gem to render your text to an image with fancy fonts and some effects with backgrounds. Might be suitable if
you ever had to generate these kind of things automatically for using them as cover or
header images. It makes use of ImageMagick for all image manipulations

## Why does this exist ?
I had a need for something like this for a project of mine and wasn't able to find anything that fit my usecase.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'kawaii_text'
```

And then execute:

$ bundle

Or install it yourself as:

$ gem install kawaii_text

## Usage

TODO: Write usage instructions here

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/owaiswiz/kawaiitext.
10 changes: 10 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
require "bundler/gem_tasks"
require "rake/testtask"

Rake::TestTask.new(:test) do |t|
t.libs << "test"
t.libs << "lib"
t.test_files = FileList["test/**/*_test.rb"]
end

task :default => :test
14 changes: 14 additions & 0 deletions bin/console
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
#!/usr/bin/env ruby

require "bundler/setup"
require "kawaii_text"

# 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(__FILE__)
8 changes: 8 additions & 0 deletions bin/setup
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#!/usr/bin/env bash
set -euo pipefail
IFS=$'\n\t'
set -vx

bundle install

# Do any other automated setup that you need to do here
40 changes: 40 additions & 0 deletions kawaii_text.gemspec
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@

lib = File.expand_path("../lib", __FILE__)
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
require "kawaii_text/version"

Gem::Specification.new do |spec|
spec.name = "kawaii_text"
spec.version = KawaiiText::VERSION
spec.authors = ["Owais"]
spec.email = ["[email protected]"]

spec.summary = %q{A Ruby Library that renders text in fancy font with some effects to an image}
spec.homepage = "https://github.com/owaiswiz/kawaiitext"

# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
# to allow pushing to a single host or delete this section to allow pushing to any host.
if spec.respond_to?(:metadata)
spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"

spec.metadata["homepage_uri"] = spec.homepage
spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
else
raise "RubyGems 2.0 or newer is required to protect against " \
"public gem pushes."
end

# Specify which files should be added to the gem when it is released.
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
end
spec.bindir = "exe"
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
spec.require_paths = ["lib"]

spec.add_development_dependency "bundler", "~> 1.17"
spec.add_development_dependency "rake", "~> 10.0"
spec.add_development_dependency "minitest", "~> 5.0"
end
6 changes: 6 additions & 0 deletions lib/kawaii_text.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
require "kawaiitext/version"

module KawaiiText
class Error < StandardError; end
# Your code goes here...
end
2 changes: 2 additions & 0 deletions lib/kawaii_text/generator.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
module KawaiiText
end
3 changes: 3 additions & 0 deletions lib/kawaii_text/version.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module KawaiiText
VERSION = "0.1.0"
end
11 changes: 11 additions & 0 deletions test/kawaii_text_test.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
require "test_helper"

class KawaiiTextTest < Minitest::Test
def test_that_it_has_a_version_number
refute_nil ::KawaiiText::VERSION
end

def test_it_does_something_useful
assert false
end
end
4 changes: 4 additions & 0 deletions test/test_helper.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
require "kawaii_text"

require "minitest/autorun"

0 comments on commit c8ec39a

Please sign in to comment.