Skip to content

Latest commit

 

History

History
244 lines (192 loc) · 9.08 KB

README.md

File metadata and controls

244 lines (192 loc) · 9.08 KB
Raw

DroidKaigi 2017 official Android app CircleCI Stories in Ready codecov

DroidKaigi 2017 is a conference tailored for developers on 9th and 10th March 2017.

Try it on your device via DeployGate

Features

  • View conference schedule and details of each session
  • Set notification for upcoming sessions on your preference
  • View a map
  • Search sessions and speakers

Contributing

We use waffle.io to manage tasks. If you'd like to contribute to the project but are not sure where to start off, please look for issues labelled welcome contribute.

We've designated these issues as good candidates for easy contribution. You can always fork the repository and send a pull request (on a branch other than master).

We do accept suggestions for translations at this page.

Development Environment

This app depends on several libraries and plugins so make sure to set them up correctly.

Java8 & retrolambda support

This project uses Java8 and retrolambda. If you haven't set up Java8 yet, install it from here, and set env JAVA_HOME or JAVA8_HOME.

Kotlin

Tests are written in Kotlin!

DataBinding

This project tries to use DataBinding.

<TextView
  android:id="@+id/txt_title"
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:maxLines="@{viewModel.titleMaxLines}"
  android:text="@{viewModel.title}" />

Custom attributes are also used like below.

<ImageView
    android:id="@+id/img_speaker"
    android:layout_width="@dimen/image_size"
    android:layout_height="@dimen/image_size"
    app:photoImageUrl="@{viewModel.imageUrl}" />

BindingAdapter like photoImageUrl is written in DataBindingHelper.java.

@BindingAdapter("photoImageUrl")
public static void setPhotoImageUrl(ImageView imageView, @Nullable String imageUrl) {
  setImageUrl(imageView, imageUrl, R.color.grey200);
}

private static void setImageUrl(ImageView imageView, @Nullable String imageUrl, @DrawableRes int placeholderResId) {
  if (TextUtils.isEmpty(imageUrl)) {
    imageView.setImageDrawable(ContextCompat.getDrawable(imageView.getContext(), placeholderResId));
  } else {
    Picasso.with(imageView.getContext())
           .load(imageUrl)
           .placeholder(placeholderResId)
           .error(placeholderResId)
           .into(imageView);
  }
}

Dagger2

This project uses DI library Dagger2. See classes in di package.

src/main/java/io/github/droidkaigi/confsched2017/di
|
|--scope
|  |--ActivityScope.java  : Scope annotation for objects being alive within activity lifecycle
|  |--FragmentScope.java  : Scope annotation for objects being alive within fragment lifecycle
|
|--AndroidModule.java     : Provides system services(e.g. PackageManager, ActivityManager)
|--ActivityComponent.java :
|--ActivityModule.java    : Provides activity-scoped objects
|--AppComponent.java      :
|--AppModule.java         : Provides application-scoped objects(e.g. SharedPreferences, HttpClient)
|--FragmentComponent.java :
|--FragmentModule.java    : Provides fragment-scoped objects

Orma

This project uses ORM library Android-Orma. Android-Orma is a lightning-fast and annotation based wrapper library of SQLiteDatabase.

Some model classes in model package having @Table annotation.

@Table
public class Session {
    @Column(indexed = true)
    @SerializedName("id")
    public int id;

    @Column(indexed = true)
    @SerializedName("title")
    public String title;

    // ...
}

These classes are saved and updated in database via repository/XXXLocalDataSource. To know more about Android-Orma, see document.

Architecture

This app uses an simple MVVM (Model-View-ViewModel) architecture using DataBinding, dependency injection and OR-mapper.

Model

  • In model package.
  • These models are POJO.
  • They are converted from API json response via Retrofit2, and stored to Database via Android-Orma.
@Table
public class Speaker {

  @PrimaryKey(auto = false)
  @Column(indexed = true)
  @SerializedName("id")
  public int id;

  @Column(indexed = true)
  @SerializedName("name")
  public String name;

  @Column
  @Nullable
  @SerializedName("image_url")
  public String imageUrl;

  ...
}

View

  • In view package.
  • "View" is not only layout xml file. Activities and Fragments are also "View".
  • "View" is refreshed by viewModel when onResume() is called.

ViewModel

  • In viewmodel package
  • "ViewModel" has all properties which is shown in "View".
  • They are bound by DataBinding. In this app, setText(), setImageResource() or setVisibility() are not used.
  • The events such as OnClickListener() are also bound by DataBinding.
<RelativeLayout
  android:layout_width="wrap_content"
  android:layout_height="wrap_content"
  android:background="@drawable/clickable_white"
  android:clickable="@{viewModel.clickable}"
  android:onClick="@{viewModel::showSessionDetail}"
  app:sessionCellBackground="@{viewModel.backgroundResId}"
  app:twowayview_colSpan="@{viewModel.colSpan}"
  app:twowayview_rowSpan="@{viewModel.rowSpan}">

  <View
    android:id="@+id/categoryBorder"
    android:layout_width="match_parent"
    android:layout_height="3dp"
    android:visibility="@{viewModel.normalSessionItemVisibility}"
    app:sessionTopicColor="@{viewModel.topicColorResId}" />
    ...

</RelativeLayout>
  • "ViewModel" has business logic.
  • If it's necessary to load data, "ViewModel" uses Repository class or DefaultPref class which are provided by Dagger2.
@Inject
SessionsViewModel(SessionsRepository sessionsRepository, MySessionsRepository mySessionsRepository) {
  this.sessionsRepository = sessionsRepository;
  this.mySessionsRepository = mySessionsRepository;
}

Credit

This project uses some modern Android libraries.

License

Copyright 2017 DroidKaigi

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.